Updated docker commands, docs

This commit is contained in:
Benjamin Sherriff
2024-03-03 16:17:56 -05:00
parent aebc3516b1
commit 39d9850c41
6 changed files with 35 additions and 13 deletions

View File

@@ -8,6 +8,12 @@ Siren is a D&D Bot built for Discord, written in Rust. Features include:
- Assistant DM tools to be defined later
## Running
1. Setup the Discord Developer Application and bot
2. Copy `.env.TEMPLATE` to `.env` and fill out the fields
3. Build the [Docker](https://www.docker.com/) application with `make build`
4. Start the application with `make up`
### Setting up the Discord Developer Application
Visit the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application. Click [here](https://discord.com/developers/docs/intro) for guides and more information.
Required Scopes:
@@ -20,9 +26,9 @@ https://discord.com/api/oauth2/authorize?client_id=<CLIENT_ID>&permissions=40671
```
The CLIENT_ID can be found in the General Information tab on the Discord Developer Portal for your application, under `Application ID`
1. Copy `.env.TEMPLATE` to `.env` and fill out the fields
2. Build the [Docker](https://www.docker.com/) application with `make build`
3. Start the application with `make up`
The DISCORD_TOKEN (used in the `.env file`) can be found under the Bot tab on the Discord Developer Portal for your application.
![DISCORD_TOKEN Example](docs/discord_token_example.png)
## Contributing
[Rust](https://www.rust-lang.org/) must be installed to run locally. See [serenity-rs/serenity](https://github.com/serenity-rs/serenity) for more information about Rust Discord API Library.
@@ -61,8 +67,10 @@ The following packages must be installed for [serenity-rs/songbird](https://gith
```
</details>
Begin the application with `cargo run` (note the database must still be running)
- `docker compose up -d db`
### Running Locally
1. Build the [Docker](https://www.docker.com/) containers with `make build`
2. Start the utility containers with `make utils`
3. Start the application with `cargo run`
The application can also be tested from within a Docker container:
```