discord-bot-ufo

A Discord BOT named 機器幽浮 maintained by jonz94

Setup

Prerequisites

• Install Bun

Getting Started

Clone this repository:

git clone https://github.com/jonz94/discord-bot-ufo.git

Change to the root directory of the project:

cd discord-bot-ufo

Install all dependencies:

bun i

Setup .env and .env.dev:

bun run setup

Then, edit .env and .env.dev environment files respectively

• .env is for production environment
• .env.dev is for development environment

Launch the development BOT locally (using .env.dev configuration):

bun start

Run test:

bun run test

Build and launch the production BOT locally (using .env configuration):

bun run build
bun run preview

Release

Prerequisites

• Install git-cliff

Instructions

1. Bump version

bun run release

2. Push commits with tags

git push --follow-tags

3. GitHub Actions will be triggered and it will build the Docker Image for us

Production

Using the following docker run command:

docker run --name="discord-bot-ufo" -d \
  --restart=unless-stopped \
  -v "$(pwd)/.env:/app/.env" \
  jonz94/discord-bot-ufo

Or using the following docker compose command:

docker compose build
docker compose up

License

See LICENSE.

Credits

• 楔六葉

  • https://x.com/sixleafs/status/1766456561504023025
  • https://hackmd.io/@3Q1PwoaDQXSlvMLWWzaBww/S1pEto_ap#Render-%E4%BD%88%E7%BD%B2-Discord-Bot

• Fellipe Utaka

  • https://dev.to/fellipeutaka/creating-your-first-discord-bot-using-typescript-1eh6
  • https://github.com/fellipeutaka/discord-bot-template