node-event-bot/README.md

34 lines
848 B
Markdown
Raw Normal View History

2022-05-05 21:52:05 +02:00
## Build Status
[![status-badge](https://wood.brudi.xyz/api/badges/kenobi/node-event-bot/status.svg)](https://wood.brudi.xyz/kenobi/node-event-bot)
2022-01-03 15:07:49 +01:00
## Requirements
- yarn
- npm
## Environment Variables
- `BOT_TOKEN` -> acquire this from your Discord Application Page
- `GUILD_ID` -> the guild this bot should be active in. Still needs to be determined manually for the moment.
- `CLIENT_ID` -> not used right now
If you want to use this locally put these values into a file called `.env` in the project root.
```.env
BOT_TOKEN=<value here>
GUILD_ID=<value here>
CLIENT_ID=<value here>
```
## Usage
- Clone repo
- cd into dir
- `yarn install`
### Building
- `yarn run build`
### Start local instance
- `yarn run watch` for hot recompile on changes
- `yarn run monitor` for hot reload on recompile
### Start normal instance
- `yarn run start`