valentijn/Discord-Bot-Builder
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Made the readme more readable, and added db-config.sql for easy importing of the database tables

Browse Source
This commit is contained in:
HerpieDerpie@example.com
2024-01-15 13:40:02 +01:00
parent 39c2ed3048
commit ce574e8f4b
2 changed files with 67 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
README.md
View File

@@ -1,89 +1,35 @@
# PS-Discord-BotBuilder
This is one of my personal projects, and I plan to update it for a while to come. This is a node.js webserver, which is hosting a website, with which you can "make" a discord bot.
This is one of my personal projects, and I plan to update it for a while to come. This is a node.js webserver, which is hosting a website, with which you can "make" a discord bot.s
<br>
### Node.js and NPM Setup
### Node.js and NPM Setup
When using this website, make sure you have [Node.js](https://nodejs.org/en) installed. When you are sure it's installed, clone the repository, and open a terminal in the folder. Then run the following command to install all required NPM packages
```bash
npm install archiver bcrypt body-parser express-session express fs-extra mysql path
```
```
<br>
### Database Setup
To get started with the project, you'll need to set up the database. Follow these steps:
To get started with the project, you'll need to set up the database. Follow these steps:
1. **Database Creation:**
1. **Database Installation:**
- Make sure you have a MySQL server installed on your machine. If not, you can download and install it from [MySQL Downloads](https://dev.mysql.com/downloads/).
- Create a new database for your project.
- Make sure you have a MySQL server installed on your machine. If not, you can download and install it from [MySQL Downloads](https://dev.mysql.com/downloads/).
- Create a new database for your project.
2. **Database Schema:**
###### Table 1: `Commands`
- **Columns:**
- `command_id` (INT, Auto Increment, Primary Key)
- `project_id` (INT)
- `command_name` (VARCHAR)
- `command_description` (VARCHAR)
- `command_response` (VARCHAR)
- **Create Table Command:**
```sql
CREATE TABLE Commands (
command_id INT AUTO_INCREMENT PRIMARY KEY,
project_id INT,
command_name VARCHAR(255) NOT NULL,
command_description VARCHAR(255),
command_response VARCHAR(255)
);
```
###### Table 2: `Projects`
- **Columns:**
- `project_id` (INT, Auto Increment, Primary Key)
- `project_name` (VARCHAR)
- `project_owner` (VARCHAR)
- `bot_token` (VARCHAR)
- `bot_id` (VARCHAR)
- **Create Table Command:**
```sql
CREATE TABLE Projects (
project_id INT AUTO_INCREMENT PRIMARY KEY,
project_name VARCHAR(255) NOT NULL,
project_owner VARCHAR(36),
bot_token VARCHAR(255) NOT NULL,
bot_id VARCHAR(255) NOT NULL
);
```
###### Table 3: `Users`
- **Columns:**
- `user_id` (VARCHAR, Default: UUID(), Primary Key)
- `username` (VARCHAR)
- `password` (VARCHAR)
- **Create Table Command:**
```sql
CREATE TABLE Users (
user_id VARCHAR(36) DEFAULT UUID() PRIMARY KEY,
username VARCHAR(255) NOT NULL,
password VARCHAR(255) NOT NULL
);
```
3. **Database Configuration:**
- Update the content in the config.json file, if you dont have it, feel free to make use of the config.json.example for the layout of the json file.
2. **Importing Tables:**:
- Import the db-config.sql file into your database using the following command:
```mysql -u {your_username} -p {your_database_name} < /path/to/db-config.sql```
- If you want to know more about the exact database structure, you can always take a look at the contents of `db-config.sql `
3. **Final Configuration:**
- Update the content in the config.json file. If you don't have it, feel free to make use of the config.json.example for the layout of the JSON file.
<br>
### Running the Application:
With the database set up and configured, you should be able to run your application. To run it, please use the following command
```bash
./startServer.sh
```
```