Development Environment

Follow the steps below to set up your development environment.

Prerequisites

You need to have Git installed on your system.

Cloning the Repository

To clone the repository, run the following command:

git clone https://github.com/thijsfranck/discord-app-example.git

Next, open the project in your preferred IDE or navigate to the project directory using the terminal.

Environment Setup

You can set up the development environment using either the automated or manual setup process.

Automated Setup

The project includes a development container to automatically set up your development environment.

To get started, refer to the setup guide for your IDE:

• Visual Studio Code
• PyCharm

Cloud Development Environment

Alternatively, you can use a GitHub Codespace to set up your development environment in the cloud.

Manual Setup

If you prefer to set up the development environment manually, follow the steps below.

Prerequisites

Please ensure Python 3.12 and Poetry are installed on your system.

Start by installing the project dependencies using Poetry:

poetry install

Finally, install the pre-commit hooks:

poetry run pre-commit install

Configuration

To configure your development environment, create a .env file in the project root directory with the following content:

DISCORD_TOKEN=<YOUR_TOKEN>

Replace <YOUR_TOKEN> with your Discord bot token.

Security Warning

Do not commit your .env file to version control or share your token with anyone!

Where do I find my Discord bot token?

See the maintainer guide for instructions on how to obtain a Discord bot token.

The example above is the minimum required configuration to run the bot. For more configuration options, refer to the Configuration section.

Running the Bot

With your development environment set up and configured, you can run the bot using the following command:

poetry run python -m discord_app_example

This command starts the bot in development mode, which enables features such as loading the .env file.

The bot should now be online and ready to respond to commands in your Discord server.

Running the Documentation Locally

To view the documentation locally, you can use the following command:

poetry run mkdocs serve

Open your browser and navigate to http://localhost:8000 to view the documentation. The changes you make to the documentation will be automatically reflected in the browser.