Rozetta

An Open Source Discord bot.

Setup

1. Duplicate .env.example and rename to .env. Provide all the values.

   Key	Description
   DISCORD_API_TOKEN	Obtained from https://developer.discord.com
   DISCORD_MAIN_GUILD_ID	Based on Discord's API docs, provide a GUILD_ID to be the "main server"
   SHARDING_TOTAL_SHARDS	Number of shards for the application to be split on
   SHARDING_INITIAL_PORT	Starting port for the exposed HTTP API, usually 5000
   SHARDING_PORT_INCREMENT	Number to add to the HTTP API port count. Recommended value is 1

2. Run npm run setup.

Building Dockerfile

This project is ready to be run with Docker, the command is the following:

npm run docker:build

This will create the required containers for the application on an empty state, database needs to be prepared next.

Database migration

To initialize the database on a new instance, the following command must be executed before running the application:

npm run database:init

Running

Once all previous steps are done, you can start the application with the following command:

npm start

Testing

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Contributing

Read CONTRIBUTING.md.

License

Rozetta is MIT licensed.