light-bot/README.md

36 lines
608 B
Markdown

# light-bot
A discord bot to check if there are any connected users on a guild ( server ).
## Project setup
```bash
$ npm install
```
## Compile and run the project
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Secrets management
The application expects a .env file in the root directory of the project
with the following variables set.
```dotenv
# The discord token obtained from your dev dashboard, requires
# privileged intents.
DISCORD_TOKEN=your_discord_app_token_goes_here
# Optional, default port is 3000
PORT=3000
```