A Discord bot for community servers — tracks keyword stats, awards achievements, manages color roles and reaction roles, and logs admin actions. Run /help in Discord for a full command reference.
- TypeScript / Node 22 / discord.js v14
- PostgreSQL 16 + Prisma
- pnpm, ESLint + Prettier, vitest, tsx
- TOML config (
@iarna/toml) + zod-validated.env - pino runtime logs, DB-backed audit logs
- Docker Compose (bot + postgres + backup sidecar)
- GitHub Actions CI + release-please
- Node 22+, pnpm, Docker
- A Discord application with a bot token (Discord Developer Portal)
- Required gateway intents (enable in Developer Portal → Bot): Server Members, Message Content
pnpm install
cp .env.example .env
cp config/config.example.toml config/config.tomlRequired .env fields:
| Variable | Description |
|---|---|
DISCORD_TOKEN |
Bot token from Developer Portal |
DISCORD_CLIENT_ID |
Application ID |
DISCORD_OWNER_IDS |
Comma-separated owner user IDs |
DATABASE_URL |
Postgres connection string |
Optional: set DISCORD_DEV_GUILD_ID to register slash commands to one guild for instant updates (omit for global registration, which can take up to 1 hour).
docker compose up -d postgres # start local Postgres
pnpm prisma:migrate:dev # apply schema
pnpm dev # tsx watch — bot logs to stdoutThe bot prints Logged in as Yuzu#XXXX when ready. Slash commands are deployed automatically on startup.
docker compose up -d --buildOn start the bot container runs prisma migrate deploy then pnpm start. No manual migration step needed.
Postgres backup: daily pg_dump at 03:00 UTC → ./backups/yuzu-YYYYMMDD-HHMMSS.sql.gz, 7-day retention. Optional Google Drive upload via rclone (see DEPLOY.md).
See DEPLOY.md for full setup instructions, env variables, and troubleshooting.
pnpm lint
pnpm format
pnpm typecheck
pnpm build
pnpm test
pnpm prisma:migrate:devsrc/
├── config/ # env (zod) + TOML loader
├── core/
│ ├── command/ # registry, dispatcher, cooldown, errors
│ ├── event-bus.ts
│ ├── logger.ts
│ └── audit-log.ts
├── features/ # one directory per domain (settings, keyword, achievement, …)
├── commands/ # slash commands grouped by category; each file exports a Command
└── db/ # prisma client
Features are isolated by domain under src/features/; commands under src/commands/ are thin handlers that call into feature services.
Uses release-please. Commits to main trigger the action; it opens a release PR. Merging that PR cuts a tag, creates a GitHub Release, and updates CHANGELOG.md. Commit messages must follow Conventional Commits.
After a release tag is cut, deploy by pulling the latest code and rebuilding:
git pull && docker compose up -d --buildMIT