Parallel

A Discord moderation bot.

Table of Contents

• Dependencies
• Environment Variables
• Starting the Bot (For the First Time)
• Contributing
• License

Dependencies

• Node
• Postgresql Server
• TypeScript (or npm install -g typescript)

Enviornment Variables

Create a .env file and paste below into it. Replace the placeholders with something valid.

• TOKEN={Discord bot token}
• CLIENT_ID={Discord client ID}
• DATABASE_URL={Postgresql connect url}

Starting the Bot (For the First Time)

Not required for starting, but recommended for personalization, replace all instances of Parallel in the src files with your bot's name.

1. Ensure all environment variables (listed above) are defined in a .env file.
2. Install all dependencies. With npm, run npm install. With yarn, run yarn install.
3. Ensure the prisma/schema.prisma file matches the structure of your database. If not, run npx prisma db push. If it already does, ensure that the client has been generated. Upon running npx prisma db push it automatically generates, but by running npx prisma generate you can generate the client locally.
4. To build the source files, run npm run build or tsc.
5. Run node deploy.js to push all slash commands to the bot.
6. To then run the compiled js files, run npm run start or node . or node dist/index.js.

After all of the steps above have been completed, for running future times, only the last step will have to be executed to start the bot.

Contributing

If you find any issues in the code or possible ways to improve the code, or want to add a new feature, please do feel free to make a pull request. However, do try staying away from huge new features.

Please do not make a pull request for the following:

• Formatting. All code is automatically formatted with prettier.
• Typos. Bringing attention to typos is appreciated, but rather just create a new issue or directly contact a developer about a typo.
• Micro performance optimizations.

Please ensure your code is well commented, formatted with prettier using the prettier settings in the .prettierrc.yml file, and thoroughly tested.

Upon getting a pull request approved, you can request the contributor role in the official Discord server

License

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-sa/4.0/.

The license is also listed in the LICENSE file. You may not impersonate the original Parallel bot as that goes against Discord's community guidelines.