Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devvali/djs-template
Simple template for your discord.js bot with discord.js Guide explanations.
https://github.com/devvali/djs-template
discord discord-bot discord-js
Last synced: about 2 months ago
JSON representation
Simple template for your discord.js bot with discord.js Guide explanations.
- Host: GitHub
- URL: https://github.com/devvali/djs-template
- Owner: DevVali
- Created: 2023-01-17T19:13:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-21T13:49:27.000Z (about 1 year ago)
- Last Synced: 2024-10-13T03:22:31.074Z (3 months ago)
- Topics: discord, discord-bot, discord-js
- Language: JavaScript
- Homepage:
- Size: 68.4 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# discord.js v14 template
> A simple template for your [discord.js](https://discord.js.org/) bot with [discord.js Guide](https://discordjs.guide/) explanations.
## Features
+ Slash commands support
+ Status and activity configuration
+ Command handler
+ Event handler
+ Components handler
+ Working with databases ([sequelize](https://sequelize.org/), [keyv](https://www.npmjs.com/package/keyv))
+ Working with APIs ([undici](https://www.npmjs.com/package/undici))
+ Logging interactions and errors
+ Using modern ES6 syntax
## Installation
To install this repository properly, run this in your command-line interface.
```
git clone https://github.com/DevVali/djs14-template.git
```
After cloning the repository, you can install all required packages.
```
npm i
```
> Tip: If you want to install only the packages of your choice, continue reading.
### Packages
All packages are installed by default, but you may not need some packages (e.g. you will not be working with databases).
#### discord.js
A package to interact with the Discord API. Required to run the bot properly.
```
npm i discord.js
```
#### keyv
Simple key-value storage that allows you to work with databases.
```
npm i keyv
```
Additionally, install @keyv/sqlite (we used SQLite in this template).
```
npm i @keyv/sqlite
```
#### eslint
ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
```
npm i --save-dev eslint
```
Additionally, install the appropriate plugin(s) for your editor of choice.
+ [ESLint for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+ [ESLint for Sublime Text](https://packagecontrol.io/packages/ESLint)
#### sequelize
Sequelize is an object-relational-mapper that allows you to work with databases.
```
npm i sequelize sqlite3
```
#### undici
An excellent library for making HTTP requests.
```
npm i undici
```
### Editor plugins
+ [Prettier for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+ [Recommended theme for your VS Code editor](https://marketplace.visualstudio.com/items?itemName=ahmadawais.shades-of-purple)
## Jump to
> Examples and explanations from the discord.js Guide.
### Commands
+ [Buttons](https://github.com/DevVali/djs14-template/blob/7357cc3dadfcca6e011d43f6cc04bd56ea40a20a/commands/button.js)
+ [Select menus](https://github.com/DevVali/djs14-template/blob/7357cc3dadfcca6e011d43f6cc04bd56ea40a20a/commands/select.js)
+ [Modals](https://github.com/DevVali/djs14-template/blob/7357cc3dadfcca6e011d43f6cc04bd56ea40a20a/commands/question.js)
+ [Context Menus](https://github.com/DevVali/djs14-template/blob/7357cc3dadfcca6e011d43f6cc04bd56ea40a20a/commands/userid.js)
+ [How do I check the bot's ping?](https://github.com/DevVali/djs14-template/blob/7357cc3dadfcca6e011d43f6cc04bd56ea40a20a/commands/ping.js)
+ [Threads and Embeds](https://github.com/DevVali/djs14-template/blob/7357cc3dadfcca6e011d43f6cc04bd56ea40a20a/commands/thread.js)
+ [Reactions, Permissions, Webhooks and Storing data with Keyv](https://github.com/DevVali/djs14-template/blob/7357cc3dadfcca6e011d43f6cc04bd56ea40a20a/commands/uwu.js)
+ [Storing data with Sequelize](https://github.com/DevVali/djs14-template/blob/7357cc3dadfcca6e011d43f6cc04bd56ea40a20a/commands/show-preference.js)
+ [Using a REST API](https://github.com/DevVali/djs14-template/blob/7357cc3dadfcca6e011d43f6cc04bd56ea40a20a/commands/neko.js)
### Components
+ [Buttons](https://github.com/DevVali/djs14-template/blob/4826e4e4f8a36adc33cb5b085e5818639457dab7/components/button.js)
+ [Select menus and Storing data with Sequelize](https://github.com/DevVali/djs14-template/blob/4826e4e4f8a36adc33cb5b085e5818639457dab7/components/preference.js)
+ [Modals](https://github.com/DevVali/djs14-template/blob/4826e4e4f8a36adc33cb5b085e5818639457dab7/components/question-modal.js)
## Starting the bot
> Tip: Don't forget to edit the `config.json` file with your [bot's configuration](https://discordjs.guide/preparations/setting-up-a-bot-application.html).
Before getting into the process of starting your discord.js bot, you will have to register your commands to Discord.
```
node deploy-commands.js
```
Refresh your Discord client and if you see your bot's commands, you're good to go!
Let's start your bot.
```
node index.js
```
If you see "Ready!" after a few seconds, congratulations on starting your discord.js bot. 🎉
### Initializing database (sequelize)
```
node dbInit.sequelize.js
```
## Contributing
This project was made as a help for programmers learning discord.js on providing them some examples how discord.js code should look like. If you found that we are missing a resource, feel free to add one by yourself and open a PR. 💖 If you decide to do so, don't forget to use the recommended editor plugins.