Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fuma-nama/discord-bot-template
Best Discord Bot template with Dashboard and Documentation
https://github.com/fuma-nama/discord-bot-template
discord-bot discord-bot-template nextjs nextjs-app-router radix-ui tailwind-css typescript
Last synced: 1 day ago
JSON representation
Best Discord Bot template with Dashboard and Documentation
- Host: GitHub
- URL: https://github.com/fuma-nama/discord-bot-template
- Owner: fuma-nama
- License: mit
- Created: 2023-05-18T14:03:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-21T17:05:54.000Z (about 1 year ago)
- Last Synced: 2024-04-17T04:18:54.296Z (6 months ago)
- Topics: discord-bot, discord-bot-template, nextjs, nextjs-app-router, radix-ui, tailwind-css, typescript
- Language: TypeScript
- Homepage: https://money-shark.vercel.app
- Size: 521 KB
- Stars: 13
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord Bot Template
The powerful discord bot template with Next.js Dashboard and Discord.js v14.
## Features
- [x] Node.js Discord Bot with discord-fp
- [x] Dashboard using Next.js App Router
- [x] Documentation Website
- [x] Kafka Event Streaming (Communication between server and dashboard)
- [x] Database (Default: Vercel Posgres + Drizzle ORM)
## Quick Start
**Demo:** https://money-shark.vercel.app
### Installation
Clone the project:
```
git clone https://github.com/SonMooSans/discord-bot-template.git
```
Install dependencies, notice that this project uses [pNPM](https://pnpm.io/) as package manager:
```
pnpm i
```
### Commands
This project is a monorepo, You can run the project in development mode:
```
pnpm run dev
```
Create Production Build:
```
pnpm run build
```
### Discord OAuth
Add `https:///api/auth/callback` as a Redirect Uri in Developer Portal.
### Environment Variables
Required variables are listed in [.env.example](/.env.example).
This project uses [Upstash Kafka](https://upstash.com/), you can register an account and get required credentials there.
By default, it uses [Vercel Postgres](https://vercel.com/docs/storage/vercel-postgres) as the database provider, please follow their docs to setup database.
### Database
This project uses [Drizzle ORM](https://orm.drizzle.team/) and [Vercel Postgres](https://vercel.com/docs/storage/vercel-postgres), you may migrate to other ORMs and database provider if you wanted.
Push database changes:
```
pnpm run db:push
```
Please make sure all environment variables are all settled before running the command.
Learn More about Drizzle ORM from their [documentation](https://orm.drizzle.team/docs/quick-start).
## Project Structure
This project is using Turborepo, you can learn more about it from their [documentation](https://turbo.build/).
| Package | Description |
| ------------------------------------------ | ---------------------------------- |
| [apps/web](./apps/web/README.md) | Web App + Documentation (Frontend) |
| [apps/bot](./apps/bot/README.md) | Discord Bot |
| [packages/docs](./packages/docs/README.md) | Documentation (Content + Utils) |
| [packages/ui](./packages/ui/README.md) | Components & Utils |
| [packages/db](./packages/db/README.md) | Database Schema & Client |
| packages/config | Configuration Files |
_Learn more about these packages by reading their README.md file_
## Security
It'll checks for user permissions before doing any operations.
You can enable permission checking in a Server Action or Route Handler by doing:
```ts
import { checkPermissions } from "@/utils/actions/permissions";
export async function myAction() {
"use server";
//notice that it is an async function
await checkPermissions();
}
```
## Scalability
### Don't depend on "Server"
We use Kafka for handling real-time operations via dashboard, so that no requests will be sent to the server that hosts the discord bot directly.
This brings a faster load speed and more better stability because the dashboad will still works even if the discord bot is temporarily unavailable.
### Serverless Ready
The dashboard is built for serverless, you are able to deploy it to any serverless hosting platforms such as Vercel, Azure and AWS.
Notice that the Discord bot server can only be deployed to traditional Node.js Server hosting services, serverless environment is incompatible.
Because they will connect to the Discord Gateway or even need a sharding manager which isn't suitable in a serverless environment.
## Typesafe
Typesafe is the key to maintain a large codebase. Although Javascript + JSDocs is perfect for libraries, it's still recommended to use Typescript for writing applications.
This template is fully written in Typescript, all the type errors will be reported at build time.
## Deploy
It is easy to deploy this application.
### Web App
The fastest way to deploy Next.js applications is to use [Vercel](https://vercel.com/new?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app).
### Bot Server
Any hosting platform that supports Node.js, such as [AWS](https://aws.amazon.com/getting-started/hands-on/deploy-nodejs-web-app/), [Render](https://render.com/), [Railway](https://railway.app/).