Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nulldev/discordjs-template
Template repository for DiscordJS Projects: sharding, i18n, QuickDB, PM2, Auto deploy
https://github.com/nulldev/discordjs-template
auto-deploy bot discord discord-bot discord-js i18n javascript nulldev pm2 quickdb template
Last synced: 25 days ago
JSON representation
Template repository for DiscordJS Projects: sharding, i18n, QuickDB, PM2, Auto deploy
- Host: GitHub
- URL: https://github.com/nulldev/discordjs-template
- Owner: NullDev
- License: mit
- Created: 2023-06-01T17:54:40.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-23T02:18:09.000Z (6 months ago)
- Last Synced: 2024-05-23T02:32:25.736Z (6 months ago)
- Topics: auto-deploy, bot, discord, discord-bot, discord-js, i18n, javascript, nulldev, pm2, quickdb, template
- Language: JavaScript
- Homepage:
- Size: 498 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DiscordJS-Template
[](https://github.com/NullDev/DiscordJS-Template) [](https://github.com/NullDev/DiscordJS-Template/issues?q=is%3Aissue+is%3Aclosed)
Template repository for DiscordJS Projects
## :question: What is this?
This is a template repository for DiscordJS projects. It includes a basic setup for a Discord bot with:
- [x] A command handler
- [x] An event handler
- [x] A typed (autocomplete) config system that supports nesting and functions
- [x] A logger (both console and file)
- [x] Slash command support
- [x] Multi language support (i18n) in both messages and commands
- [x] QuickDB for persistent storage
- [x] Deployment via GitHub Actions and [PM2](https://pm2.keymetrics.io/)
- [x] ESLint
- [x] Cron jobs for scheduled tasks such as cleanups (logs / database)
- [x] Sharding support
- [x] Admin / User only commands
- [x] Easy to set up
- [x] Minimalistic REST-API base for potential dashboard or OAuth
## :diamond_shape_with_a_dot_inside: Feature requests & Issues
Feature request or discovered a bug? Please [open an Issue](https://github.com/NullDev/DiscordJS-Template/issues/new/choose) here on GitHub.
## :white_flower: Other branches
There are other branches with different feature sets:
- [master](https://github.com/NullDev/DiscordJS-Template/tree/master) - The default branch with all features (if you can read this, you are already here)
- [no-i18n](https://github.com/NullDev/DiscordJS-Template/tree/no-i18n) - No i18n / multi language support, command localization, etc
- [webserver](https://github.com/NullDev/DiscordJS-Template/tree/webserver) - A basic webserver with a REST-API base e.g. for OAuth or a dashboard [CURRENTLY OUTDATED!!!]
## :wrench: Dev Setup
0. Open up your favourite terminal (and navigate somewhere you want to download the repository to).
1. Make sure you have NodeJS installed (>= v20.0.0). Test by entering
$ `node -v`
If this returns a version number, NodeJS is installed. **If not**, get NodeJS here.
2. Clone the repository and navigate to it. If you have Git installed, type
$ `git clone https://github.com/NullDev/DiscordJS-Template.git && cd DiscordJS-Template`
If not, download it here and extract the ZIP file.
Then navigate to the folder.
3. Install all dependencies by typing
$ `npm install`
4. Copy [config/config.template.js](https://github.com/NullDev/DiscordJS-Template/blob/master/config/config.template.js) and paste it as `config/config.custom.js` OR use `npm run generate-config`.
5. Configure it in your favourite editor by editing `config/config.custom.js`.
6. Change some strings by running
$ `npm run setup-template`
7. Start it in development mode by running
$ `npm start`
or start in production mode
$ `npm run start:prod`
## :satellite: Things to change in the template
> NOTE: You don't have to do that manually. Just run `npm run setup-template` !
- package.json
- [name](https://github.com/NullDev/DiscordJS-Template/blob/master/package.json#L2)
- [description](https://github.com/NullDev/DiscordJS-Template/blob/master/package.json#L6)
- [repository links](https://github.com/NullDev/DiscordJS-Template/blob/master/package.json#L20-L27)
- [author](https://github.com/NullDev/DiscordJS-Template/blob/master/package.json#L28)
- pm2.ecosystem.json
- [name](https://github.com/NullDev/DiscordJS-Template/blob/master/pm2.ecosystem.json#L4)
- [repo](https://github.com/NullDev/DiscordJS-Template/blob/master/pm2.ecosystem.json#L10)
- Bot Info Tagline
- [English](https://github.com/NullDev/DiscordJS-Template/blob/master/locales/English_en.json#L8)
- [German (example)](https://github.com/NullDev/DiscordJS-Template/blob/master/locales/German_de.json#L8)
- Bot Info Author / Link
- [author name](https://github.com/NullDev/DiscordJS-Template/blob/master/src/commands/user/info.js#L59)
- [repo link or website](https://github.com/NullDev/DiscordJS-Template/blob/master/src/commands/user/info.js#L64)
- Bot invite link in issues
- [config.yml](https://github.com/NullDev/DiscordJS-Template/blob/master/.github/ISSUE_TEMPLATE/config.yml#L4)
- And you probably want to change this README here :P
## :rocket: Deployment
- Clone the repo to your server
- Add the correct [secrets](https://github.com/NullDev/DiscordJS-Template/blob/master/.github/workflows/cd.yml#L27-L34) to your repository settings
- SSH_HOST: The host (domain / IP) of the server you want to deploy to
- SSH_PORT: The SSH port of the server you want to deploy to (usually 22)
- SSH_USER: The SSH user of the server you want to deploy to
- SSH_KEY: The private SSH key of the server you want to deploy to
- REPO_PATH: The path to the repository on the server (where you cloned to, e.g.: `/home/bots/MyCoolBot`)
- PM2_HOME: [OPTIONAL] The path to the PM2 home directory, if it's custom (e.g.: `/home/bots/.pm2`)
- Install PM2 on the server by running `npm install pm2 -g`
- Start the bot initially by running `pm2 start pm2.ecosystem.json`
- Save the current PM2 configuration by running `pm2 save`
- Enable PM2 to start on boot by running `pm2 startup` and following the instructions
- Done! :tada:
## :nut_and_bolt: Configuration
Once the config has been copied like described in [Step 4](#wrench-dev-setup) of the setup, it can be changed to your needs:
| Config Key | Description | Data Type | Default value |
| ---------- | --------- | ------------------ | ------------ |
| discord:
`bot_token` | Auth Token of the Discord bot. Can be created [here](https://discordapp.com/developers/). | String | N/A |
## :star: Bots using this Template
- [NullDev/Arithmetica-Bot](https://github.com/NullDev/Arithmetica-Bot) - A counting bot that supports arithmetic expressions
- [NullDev/Discord-RoleShop](https://github.com/NullDev/Discord-RoleShop) - A Bot for a Roleshop with currency that can be earned by writing messages
- [arellak/gpt_image_discord_bot](https://github.com/arellak/gpt_image_discord_bot) - A Discord bot that generates images using DALL-E
- [arellak/mukaji_chat](https://github.com/arellak/mukaji_chat) - Chat bot using Markov chains
- [altrusin/chimera](https://github.com/altrusin/chimera) - A Discord management bot
- ... you? Create an [issue](https://github.com/NullDev/DiscordJS-Template/issues/new/choose) or a [PR](https://github.com/NullDev/DiscordJS-Template/pulls) to get featured here!
## :scroll: License
This Template is Licensed under [MIT](https://github.com/NullDev/DiscordJS-Template/blob/master/LICENSE).
**You are free to change the license in your Project to whatever you want!**
But _please_ credit this Repository here in some way, shape or form :)
Here's a bade you can use:
[](https://github.com/NullDev/DiscordJS-Template)
```markdown
[](https://github.com/NullDev/DiscordJS-Template)
```
## :octocat: Contributors
Made with [contrib.rocks](https://contrib.rocks).
