discord-bun-boilerplate

A tiny, fast Discord bot boilerplate built for Bun.js — minimal, modern, and ready to publish.

Features

• Bun-first: works with bun run and bunx.
• Command and event loaders (drop-in files).
• Simple CLI shim for running the bot after publishing.

Clone command

bunx @sush1sui/dc-boilerplate my-bot

Quickstart (local)

1. Install dependencies:

bun install

2. Start server:

# Development (with hot reload)
bun run dev

# Production
bun run start

Configuration & Where to edit

• Commands: add files under src/bot/commands/utility.

  • Example: src/bot/commands/utility/ping.ts
  • Each command should export data (a SlashCommandBuilder) and execute(interaction).

• Events: add files under src/bot/events/.

  • Example: src/bot/events/ping.ts.
  • Each event file should export name, optional once, and execute(...args).

• Bot config and startup: src/bot/bot.ts — adjust intents and client options there.

• CLI entry: bin/cli.ts — sets BOT_TOKEN and imports src/index.ts.

Publishing notes

• Ensure package.json bin field is correct and the bin/ files are included in the package.
• Consider adding a .npmignore or updating files in package.json to control published files.

License

• MIT