Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 1.38 KB

Contributing to Paul

In order to get up and running with this project, you need to first clone the repository.

$ git clone https://github.com/abrahammurciano/paul-bot.git

Then, you need to create a development envrironment with the dependencies installed. (You need to to already have poetry installed for this command to work.)

$ poetry install

You obviously need to create a Discord bot to get a token.

You must create a database if you want to run the bot locally. You can use https://www.elephantsql.com/ for that. Once you have the database, run paul/data/schema.psql on that database to create the necessay database schema.

$ psql -h hostname -d databasename -U username -f paul_bot/data/schema.psql

You will then need to add the following settings to your .env file to configure the bot.

BOT_TOKEN=<Your bot token goes here.>
DATABASE_URL=<Your database URL goes here.>
ERR_CHANNEL=<Optional. The ID of a Discord channel where the bot will send errors to.>
DBG_CHANNEL=<Optional. The ID of a Discord channel where the bot will send debug messages to.>
MAX_DB_CONNECTIONS=<Optional. The maximum number of database connections to open. This depends on your database hosting plan.>

Finally, you can run the bot:

$ poetry shell  # This will start a shell with the development environment. You only need to do it once per shell session.
$ paul