Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 2.2 KB

README.md

File metadata and controls

97 lines (62 loc) · 2.2 KB

welcome2voice-bot

🤖 NODE.TS - Play a welcome sound every time someone joins the voice channel.

🤖 INVITE-ME 🤖

How to use

After installing the bot on your discord server, just join a voice channel and the bot will automatically play the welcome sound. If nothing happens, make sure the bot has the necessary permissions to connect to the voice channel.

Installation (Development)

Clone project

git clone git@github.com:BrunoS3D/welcome2voice-bot.git
cd welcome2voice-bot

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