dev.md

Developer documentation

Setup

Before you run the application, you need to setup a .env file with the following vars:

1. DISCORD_BOT_ID
   • This is the application ID you can get from https://discord.com/developers/applications. It's only used for the deploy script.
2. DISCORD_TOKEN
   • This is the Discord token you can get from https://discord.com/developers/applications
3. MONGO_URI
   • This should be a MongoDB URI for database access
4. NODE_ENV
   • This should be set to development or production. Decides what DB is used.
5. PROD_ERROR_EMAIL
   • This is the email address it will use to send errors to when run in production mode

Required variables are in bold.

Running

1. Install node
2. Enable corepack to use yarn
   • corepack enable
3. Install package dependencies
   • yarn install
4. Run the bot in dev mode
   • yarn dev
5. To run it in production mode, you can use
   • yarn build && yarn start
6. Before commiting, run the linter and formatter
   • yarn lint
   • yarn format
7. You can use the following commands to fix code issues
   • yarn lint-fix
   • yarn format-fix

Updating Slash Commands

Once the bot is running for the first time, you'll notice the slash commands aren't available. To fix this, run node deploy.mjs which will load the env file, then remove and reregister the slash commands to the bot. It might take a minute or two for Discord to notice! If you remove or update any new command files, you'll need to rerun this to get the new commands updated. Editing an existing command does not require this to be run. Sometimes discord caches commands, so if updated commands or props don't work, restart your discord client.