Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codeize/template
✨ A template for advanced Discord bots.
https://github.com/codeize/template
discord discord-bot discord-bot-template typescript
Last synced: 4 days ago
JSON representation
✨ A template for advanced Discord bots.
- Host: GitHub
- URL: https://github.com/codeize/template
- Owner: Codeize
- License: mit
- Created: 2022-07-27T21:53:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-18T18:06:01.000Z (over 1 year ago)
- Last Synced: 2023-05-18T19:25:20.315Z (over 1 year ago)
- Topics: discord, discord-bot, discord-bot-template, typescript
- Language: TypeScript
- Homepage: https://github.com/Codeize
- Size: 121 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Codeize's Discord Bot Template
This is a monorepo template for advanced Discord bots.
> **Note**
> This template requires at least an intermediate understanding of TypeScript, Prisma/MySQL and the Discord API, and you'll need to familiarize yourself with the concepts of a monorepo. You'll find things very hard if you don't follow the above.
## Demo
TODO: Insert gif or link to demo
## Setup
1. Clone the repo
```bash
git clone https://github.com/Codeize/template.git
```
2. Install dependencies
```bash
pnpm install
```
3. Create and fill in a `.env` file as per the example dataset provided in `.env.example`.
4. Sync the database
```bash
pnpm db:push
```
5. Start the bot
```bash
pnpm dev
```
## Used By
Here are some bots that use this template, or a modified version of it:
- [PizzaPlace](https://pizzaplace.lol)
- [Kiai](https://kiaibot.com)
## Roadmap
- [ ] Prometheus & Grafana Support
- [ ] Website
- [ ] Internal API
- [ ] Vote Handler
- [ ] Docker Support
- [ ] Better Documentation
- [ ] Demo Video
- [ ] Admin Panel
- [ ] Dashboard
- [ ] Marketing Website
- [ ] More API Route Examples
- [ ] API Rate Limiting
## Contributing
Contributions are always welcome!
If you have a suggestion or spot a bug feel free to open an issue and I'll get back to you as soon as I can.
## Acknowledgements
- [Shadow](https://github.com/thewilloftheshadow) for many discussions on how initial the initial template by Polar could be improved, aswell as help with the code along the way.
- [Polar](https://github.com/xPolar) at [OtterDevelopment](https://github.com/OtterDevelopment) for creating [the initial version of this template](https://github.com/OtterDevelopment/typescript-discord-boilerplate).
## Support
For support, you can start an issue and I'll try help you out there.