discord-record-bot

Description

A basic bot that sends a welcome message, with potential for more features in the future.

It is working on discord server Order of Devs Community.

Table Of Content

• Description
• Commands
• Prerequisites
• Quick Start Guide
  • Using Docker
  • Without Docker
• Dependencies
• Development Dependencies
• Links

Commands

• "start" - runs the application

How to run it:

npm start

• "dev" - runs the application in watch mode

How to run it:

npm dev

• "docker build -t discord-bot ." - build the Docket image

How to run it:

docker build -t discord-bot .

• "format" - runs the Biome.js to format all (js, jsx, ts, tsx, json) files in src directory

How to run it:

npm run format

• "format:check" - runs the Biome.js to check the formatting all (js, jsx, ts, tsx, json) files in src directory

How to run it:

npm run format:check

• "lint:check" - runs the Biome.js to check only linting issues in files (js, jsx, ts, tsx, json)

How to run it:

npm run lint:check

• "lint:fix" - runs the Biome.js to check for linting issues and automatically fix them in files (js, jsx, ts, tsx, json)

How to run it:

npm run lint:fix

Prerequisites

• Node.js
• Docker - optional if you want run it inside container

Quick Start Guide

Using Docker

1. Clone repository:

Command for SSH

git clone git@github.com:UgzSourceCode/discord-user-bot.git

Command for HTTPS

git clone https://github.com/UgzSourceCode/discord-user-bot.git

2. Build the Docker image:

Navigate to the cloned repository folder and run:

docker build -t discord-bot .

3. Configure the bot:

There is an example configuration in the .env-sample file. Please create a .env file and populate it with your own values.

4. Run the bot:

docker run --env-file .env discord-bot

Without Docker

1. Clone repository:

Command for SSH

git clone git@github.com:UgzSourceCode/discord-user-bot.git

Command for HTTPS

git clone https://github.com/UgzSourceCode/discord-user-bot.git

2. Install dependency:

Navigate to the cloned repository folder and run:

npm install --production

3. Configure the bot:

There is an example configuration in the .env-sample file. Please create a .env file and populate it with your own values.

4. Run the bot:

npm start

Dependencies

• discord.js
• dotenv
• ts-node
• modclean
• pino
• pino-pretty
• pino-tee

Development Dependencies:

• @types/node
• ts-node-dev
• typescript
• @biomejs/biome

Links:

• Issues