Skip to content

Latest commit

 

History

History
99 lines (88 loc) · 2.48 KB

README.md

File metadata and controls

99 lines (88 loc) · 2.48 KB
Raw

logo

VeniBot Dashboard

Discord Server

About the repository

This repository contains the VeniBot API and control panel

Launch

For the dashboard to work, you need:
  • Any of the databases supported by TypeORM
  • Discord bot account
  • Node.js 16.x (other versions not tested)
  • Package manager Yarn

Copy the repository and navigate to the folder

$ git clone https://github.com/Kasefuchs/VeniBot-Dashboard.git
$ cd VeniBot-Dashboard

Install dependencies

In your project root folder enter these commands 
$ cd server
$ yarn install
$ cd ../dashboard
$ yarn install
$ cd ..

Installing the database driver

Go to server folder

$ cd server

...and install the driver you need based on the table below

Database Driver Command
MySQL or MariaDB mysql yarn add mysql
PostgreSQL or CockroachDB pg yarn add pg
SQLite sqlite3 yarn add sqlite3
Microsoft SQL Server mssql yarn add mssql
Oracle oracledb yarn add oracledb
MongoDB mongodb yarn add mongodb@^3.6.0

Create dotenv files

Rename .env.example in dashboard and server directories as .env and fill values

Build

run build script in dashboard and server directories

Finally run

use pm2 or run in different terminals

just run start script in dashboard and server directories

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

VeniBot Dashboard is AGPL-3.0 licensed.