another-chill-spring
/
discord-dropdown-poc
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

📝 setup instruction on README.md

This commit is contained in:
Aymeric GUERACAGUE 2022-06-30 14:01:52 +02:00
parent 3c62ff24db
commit 1cfc4a8fa8
Signed by: Superkooka
GPG Key ID: F78F2B172E894865
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -0,0 +1,16 @@
# Discord Dropdown POC
A POC of a Discord bot using the dropdown capability
## How to install
1. Clone the repo
2. Clone the config.exemple.toml and rename it config.toml
3. Launch the docker container with `make start` or `docker-compose up`
4. Go into the docker container with `make shell` or `docker-compose exec discord-bot bash`
5. Install the dependencies: `yarn`
6. Compile typescript and run the bot with `yarn dev`
## Contributions/License
This project has an AGPLv3 license. This project use the `Sheweny` framework with `discord.js` underlying and `BinaryMuse/toml-node` for configuration parsing.