Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonz94/discord-bot-ufo
🤖 A Discord BOT named 機器幽浮
https://github.com/jonz94/discord-bot-ufo
Last synced: 12 days ago
JSON representation
🤖 A Discord BOT named 機器幽浮
- Host: GitHub
- URL: https://github.com/jonz94/discord-bot-ufo
- Owner: jonz94
- License: 0bsd
- Created: 2024-03-10T10:47:54.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T03:15:51.000Z (13 days ago)
- Last Synced: 2024-10-26T16:52:40.545Z (12 days ago)
- Language: TypeScript
- Homepage: https://hub.docker.com/r/jonz94/discord-bot-ufo
- Size: 1.08 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# discord-bot-ufo
A Discord BOT named `機器幽浮` maintained by [jonz94](https://github.com/jonz94)
## Setup
### Prerequisites
- Install [Bun](https://bun.sh)
### Getting Started
Clone this repository:
```shell
git clone https://github.com/jonz94/discord-bot-ufo.git
```
Change to the root directory of the project:
```shell
cd discord-bot-ufo
```
Install all dependencies:
```shell
bun i
```
Setup `.env` and `.env.dev`:
```shell
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):
```shell
bun start
```
Run test:
```shell
bun run test
```
Build and launch the production BOT locally (using `.env` configuration):
```shell
bun run build
bun run preview
```
## Release
### Prerequisites
- Install [git-cliff](https://git-cliff.org/)
### Instructions
1. Bump version
```shell
bun run release
```
2. Push commits with tags
```shell
git push --follow-tags
```
3. [GitHub Actions](https://github.com/jonz94/discord-bot-ufo/actions/workflows/build.yml) will be triggered and it will build the [Docker Image](https://hub.docker.com/r/jonz94/discord-bot-ufo) for us
## Production
Using the following `docker run` command:
```shell
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:
```shell
docker compose build
docker compose up
```
## License
See [LICENSE](https://github.com/jonz94/discord-bot-ufo/blob/main/LICENSE).
## Credits
- [楔å…葉](https://x.com/sixleafs)
- https://x.com/sixleafs/status/1766456561504023025
- https://hackmd.io/@3Q1PwoaDQXSlvMLWWzaBww/S1pEto_ap#Render-%E4%BD%88%E7%BD%B2-Discord-Bot
- [Fellipe Utaka](https://github.com/fellipeutaka)
- https://dev.to/fellipeutaka/creating-your-first-discord-bot-using-typescript-1eh6
- https://github.com/fellipeutaka/discord-bot-template