Skip to content

Commit

Permalink
Merge pull request #47 from Contraversum/docs-update
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
TheLlamamarketer authored Sep 21, 2023
2 parents e6b265f + 887b9c6 commit 9f0640d
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions documentation/Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,26 @@ Navigate to the "Bot" tab .
Under the "TOKEN" section, click "Copy" to get your bot token.
Setting Up the Token Locally:

Create a config.json file in the root directory of the project.
Create a '.env' file in the root directory of the project.
Inside the config file, set your token like this: token:"XXX".
If you suspect your bot token has been compromised, go back to the Discord Developer Portal and regenerate the token immediately.
If you suspect your bot token has been compromised, go back to the Discord Developer Portal and regenerate the token immediately. Along with the Token you will need to set up the other secrets that can be found in the moderator channel of the Contraversum Discord server.

## Setting up for production

You will need to join the ContraversumTest Discord Server. Here you will find the production bot. You can access the production bot by creating a branch from the 'pre-production' branch and altering the .env file. With the secrets that can be found in the moderator channel of the Contraversum Discord server.

### Setting up the MongoDB database

The production bot uses a MongoDB database. You can set up a MongoDB database using the following steps:

1. Install MongoDB https://www.mongodb.com/docs/manual/administration/install-community/
2. Create a database called 'contrabot'
3. Create a collection called 'users'

### Acessing the live database

You can access the live database using the following steps:


## Running the Bot

Expand Down

0 comments on commit 9f0640d

Please sign in to comment.