Refer to the official discord.py documentation to create a bot.
Also, please make sure that the scope application.commands is enabled.
Make sure to enable intents as well—check the official guide for detailed instructions here.
-
Fork the repository to your own profile.
-
Set up a local PostgreSQL database or use Docker.
postgresql://username:password@localhost/db_nameReplace username, password, db_name with appropriate values.
-
To install packages, run:
pip install poetry poetry install
-
Once all the packages are installed, run migrations using:
python cli.py migrate up -
Create a .env file and copy the contents of example.env, setting up the environment variables.
-
Once the above steps are done, run the bot using the command:
python cli.py
-
Feel free to join the server in case of any issues.
-
Ensure you have Docker installed and set up on your system. Refer to the Docker's official guide if needed.
-
To run a PostgreSQL instance, execute:
docker compose up -d postgres
The
-dflag runs the instance in detached mode. -
Run migrations.
python cli.py migrate up
Please adhere to the following guidelines when contributing:
- Follow the coding style and conventions used in the project.
- Write clear and concise commit messages.
- Test your changes thoroughly before submitting a pull request.
- Be respectful and constructive in all interactions with other contributors.
- Ensure your code follows best practices and is well-documented.
- Write unit tests for new features and ensure existing tests pass.
- Perform code reviews and address feedback from other contributors.