A Discord bot made with nyxx and nyxx_commands!
This brick includes a devcontainer to make developing with Docker and docker-compose easier. Devcontainers allow you to have access to your other docker-compose services such as databases without having to run them manually on your host machine.
If you're using a devcontainer-compatible IDE, you can follow the setup instructions for that IDE:
- vscode: https://code.visualstudio.com/docs/devcontainers/containers#_getting-started
- GitHub codespaces: https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository
- JetBrains: Local devcontainers are currently unsupported. Follow the instructions for GitHub codespaces, then connect to it from your IDE.
Once you're ready to open your container, rename .env.example to .env and replace the placeholders with their real values. Then, you can open your project in the devcontainer:
- vscode: Run the
Dev Containers: Reopen in Containercommand from the command palette - GitHub codespaces: https://docs.github.com/en/codespaces/developing-in-codespaces/opening-an-existing-codespace
To run your bot, make sure that you have set up your .env file correctly, then run docker compose up. Add the --build flag if you have made changes to your bot since the last time it started, and add the -d flag if you want it to run in the background.
To stop your bot, either press Ctrl+C if you didn't use the -d flag or run docker compose down.
Now that you've created your project, here's what to do next:
- Check out the example bot
- Join the support server
- Visit the docs