🤖 discord-node-bot-boilerplate

Create your discord bot with this awesome boilerplate. Use this template for your bot.

This is a github template, you can fork it or use it as a template to start a new project with this repository as hello-world. Use this template to start ahead without losing time configuring your own!

A huge thanks goes to my friend PTKdev for giving me inspiration from his beautiful templates! Go check him out!

🎁 Support: Donate

This project is free, open source and I try to provide excellent free support.

📎 Menu

• 💡 Features
• 📚 Documentation
• 🔨 Developer Mode
• • 🏁 Run Project
• • 💾 Setup Project
• • 🚀 Deploy
• 👨‍💻 Contributing
• 🐛 Known Bugs

💡 Features

• [✔️] Easy to use
• [✔️] MIT License
• [✔️] Make discord bot with node
• [✔️] Friendly boilerplate + Github templates
• [✔️] Optional MongoDB with Moongoose
• [✔️] Optional rest api preconfigured
• [✔️] Optional JWT Security
• [✔️] Typescript + TSPaths preconfigured
• [✔️] Userfriendly folders tree
• [✔️] Prettify and ESLint preconfigured
• [✔️] all-contributors-cli and all-shields-cli preconfigured
• [✔️] JEST Test preconfigured
• [✔️] Full async code
• [✔️] Github and Vscode dotfiles preconfigured
• [✔️] Translations: 🇬🇧 🇮🇹

🔨 Developer Mode

🏁 Run Project

1. Clone this repository or download nightly, beta or stable.
2. Go to @discord api and create a new bot (Obtain an API Key / CLIENT ID key / GUILD ID key)
3. Run npm run init
4. Run with correct values: npm run configure --botkey name_bot --clientid 1234:asdfghjkl --guildid 1234:asdsfssad --mongodb 1234:3242342 --jwtsecret somesecretstring (MongoDB and JWT are optional)
5. Run npm run dev

By default both MONGODB and a REST API are enabled, to disable them just use these commands:

npm run enable-db dev
npm run enable-api dev
npm run disable-db dev
npm run disable-api dev

npm run enable-db prod
npm run enable-api prod
npm run disable-db prod
npm run disable-api prod

💾 Setup Project

If you want to replace all strings (for example: package name, author, URLs, etc...) in the markdown file, source files and other files of this project you need to edit setup.json with the correct values and run npm run setup.

🚀 Deploy

Deploy bot to your server and:

1. Run npm run init
2. Run with correct values: npm run configure --botkey name_bot --clientid 1234:asdfghjkl --guildid 1234:asdsfssad --mongodb 1234:3242342 --jwtsecret somesecretstring (MongoDB and JWT are optional)
3. Generate release npm run release
4. Start bot npm run start-pm2

📚 Documentation

Run npm run docs

👨‍💻 Contributing

I love contributions! I will happily accept your pull request! Translations, grammatical corrections, code correction and suggestions. Remember to insert your name in .all-contributorsrc and package.json files.

Many thanks goes to these wonderful people (emoji key):

Ali Shadman 💻 🌍 📖 🐛

Patryk Rzucidło 💻 🌍 📖 🐛

🦄 Other Projects

💫 License

• Code and Contributions have MIT License
• Images and logos have CC BY-NC 4.0 License
• Documentations and Translations have CC BY 4.0 License

Copyleft (c) 2022 Ali Shadman <support@@alishd.dev>