Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add DiscordBot README for better new dev onboarding process #12

Merged
merged 12 commits into from
Feb 16, 2024
Merged

Add DiscordBot README for better new dev onboarding process #12

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fe8c2fc
docs: discord bot readme
rodonguyen Feb 11, 2024
9ab9a93
docs: add auto formatter
rodonguyen Feb 11, 2024
cfeee49
Merge remote-tracking branch 'upstream/main' into readme-discord-bot
rodonguyen Feb 15, 2024
456cf07
docs: add instructions for discord bot dev
rodonguyen Feb 15, 2024
9549905
chore: reword
rodonguyen Feb 15, 2024
9b785a2
feat: add `ruff` package
rodonguyen Feb 15, 2024
4ab053b
docs: "add package to pyproject.toml" instructions
rodonguyen Feb 15, 2024
1b0ac8a
docs: add and apply `ruff format .`
rodonguyen Feb 15, 2024
4f5a1e9
docs: edit ruff commands
rodonguyen Feb 16, 2024
1bbd21f
Merge remote-tracking branch 'upstream/main' into readme-discord-bot
rodonguyen Feb 16, 2024
7e0eba7
docs: resolve change requests
rodonguyen Feb 16, 2024
52cf618
chore: add extra line
rodonguyen Feb 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,13 @@ When you’re done working in the virtual environment, simply type:
```
exit
```

## Discord Bot Development

### Getting started
- [Create a bot in discord](https://interactions-py.github.io/interactions.py/Guides/02%20Creating%20Your%20Bot/).
- Add that bot to a test server.
- When making the invite through OAuth2 URL Generator, make sure to enable `bot` and `applications.commands` options.
- Follow the [Invite your bot](https://interactions-py.github.io/interactions.py/Guides/02%20Creating%20Your%20Bot/) section for reference.
- Copy out `.env.example` into `.env`, and fill in the `DISCORD_BOT_TOKEN` and `DISCORD_GUILD_ID`.
- Now, run the bot code locally and test the bot on your server.
Loading