Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.12 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.12 KB

Mokuroku

A hassle-free, highly performant, host-it-yourself Discord anime watch-list bot

Deployment

Usage

Make a copy of .env.example and name it .env.

Then create a bot account, and copy its token to .env with the DISCORD_TOKEN environment.

You also need to enter your MongoDB cluster info into the .env file.

Docker

docker run -d --env-file .env ghcr.io/Shorakie/mokuroku:latest

Development

Make sure you've installed Rust. You can install Rust and its package manager, cargo by following the instructions on https://rustup.rs/. Simply run cargo run.

Testing

Tests are available inside the src/tests folder. They can be ran via cargo test. It's recommended that you run the tests before submitting your Pull Request. Increasing the test coverage is also welcome.

Docker

Within the project folder, simply run the following:

docker build -t mokuroku .
docker run -d --env-file .env mokuroku