discord-bot-typescript-boilerplate

🤖 NODE.TS - Start your next discord bot project in seconds.

Installation

Clone project

git clone git@github.com:BrunoS3D/discord-bot-typescript-boilerplate.git your-app-name
cd your-app-name

Install dependencies

yarn install # or just yarn

Create environment variable files .env and .env.dev based on .env.example on project root folder

# linux / macOS
cp .env.example .env
cp .env.example .env.dev

# windows
copy .env.example .env
copy .env.example .env.dev

Running on development environment

⚠ Remember to follow the Installation steps before proceeding

Running the bot

yarn dev # or cross-env NODE_ENV=development env-cmd -f .env.dev tsnd --transpile-only --respawn --no-notify --ignore-watch node_modules ./src/index.ts

⚠ Note that the loaded environment variables file is .env.dev

Running on production environment

With Docker

⚠ Remember to follow the Installation steps before proceeding

docker build -t your-app-name .
docker run -it --rm -e DISCORD_TOKEN="YOUR TOKEN HERE" --name your-app-name your-app-name

With Docker Compose

⚠ Remember to follow the Installation steps before proceeding

docker compose up -d

⚠ Note that the loaded environment variables file is .env

Without Docker Compose

⚠ Remember to follow the Installation steps before proceeding

Directly

yarn deploy

⚠ Note that the loaded environment variables file is .env

Manually

yarn build

Startup bot

yarn start # or cross-env NODE_ENV=production env-cmd -f .env node ./dist/index.js

⚠ Note that the loaded environment variables file is .env