Document setup and environment variables

Author: object-Object

README.md

@@ -9,3 +9,59 @@ This project is set up as a monorepo using [Rye](https://rye.astral.sh). To get
 ```sh
 rye run setup
 ```
+
+### Discord bot
+
+1. [Create a Discord bot](https://discordpy.readthedocs.io/en/stable/discord.html) for development.
+2. Copy the bot token.
+
+### GitHub app
+
+1. [Create a GitHub app](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) for development.
+   * Callback URL: `http://localhost:7100/login`
+   * Webhook events: No
+   * Permissions:
+     * Repository:
+       * Issues: Read-only
+       * Metadata: Read-only
+   * Where can this GitHub App be installed: Only on this account
+2. Generate and copy a new client secret.
+3. Generate and download a new private key.
+
+### Environment variables
+
+`.env`:
+
+```sh
+TOKEN="Discord bot token"
+GITHUB="{}"
+GITHUB__APP_ID="GitHub app id"
+GITHUB__CLIENT_ID="GitHub app client id"
+GITHUB__CLIENT_SECRET="GitHub app client secret"
+GITHUB__REDIRECT_URI="http://localhost:7100/login"
+GITHUB__DEFAULT_INSTALLATION_ID="GitHub app repository installation id"
+
+ENVIRONMENT="dev"
+API_PORT="7100"
+API_ROOT_PATH=""
+DB_URL="sqlite:///db.sqlite"
+```
+
+`.env.docker`:
+
+```sh
+TOKEN="..."
+GITHUB__APP_ID="..."
+GITHUB__CLIENT_ID="..."
+GITHUB__CLIENT_SECRET="..."
+GITHUB__REDIRECT_URI="http://localhost:7100/login"
+GITHUB__DEFAULT_INSTALLATION_ID="..."
+```
+
+`secrets/github__private_key`: GitHub app private key file.
+
+## Running
+
+Local: `rye run bot`
+
+Docker: `docker compose up`