https://github.com/jakyeru/package-skeleton-discordjs

A skeleton repository for Discord.js projects.
https://github.com/jakyeru/package-skeleton-discordjs

discordjs javascript nodejs

Last synced: 10 days ago
JSON representation

A skeleton repository for Discord.js projects.

• Host: GitHub
• URL: https://github.com/jakyeru/package-skeleton-discordjs
• Owner: JakyeRU
• License: mit
• Created: 2021-11-08T09:15:24.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-16T02:15:17.000Z (7 months ago)
• Last Synced: 2024-10-29T14:24:05.103Z (about 2 months ago)
• Topics: discordjs, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 259 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    

                

    





    

    



# About package-skeleton-discordjs

package-skeleton-discordjs is a template that uses the latest [discord.js](https://github.com/discordjs/discord.js) version to help you create a project in minutes without the hassle of creating each file individually.

# Features

- slash commands support;

- sharding support;

- uses the latest discord.js version;

- deploy slash commands easy using `npm run deploy`

- deploying in minutes;

- ready for production;

# Installation

### Step 1: Create a new repository using this template.

Press the green button "Use this template" or [click here](https://github.com/JakyeRU/package-skeleton-discordjs/generate).

### Step 2: Download your newly created repository and install the dependencies.

After downloading your repository, you need to install the dependencies. At the root directory of your project, run the following command:

```bash

npm install

```

### Step 3: Copy .env.example to .env and update the values.

> DISCORD_AUTH_TOKEN= <> (Your Discord bot token)

### Step 4: Run the bot.

At the root directory of your project, run the following command:

```bash

npm start

```

Your bot is now running and ready to use.

# About configuration.json

`DISCORD_CLIENT_ID` - This is the client id of your Discord bot. _You shouldn't worry about setting it manually as we will automatically set it for you._

`DISCORD_TESTING_GUILD_ID` - This is the id of the guild where [guild slash commands](https://discordjs.guide/interactions/registering-slash-commands.html#guild-commands) will be registered.

### Why do I need a testing guild?

> Global commands are cached for one hour. New global commands will fan out slowly across all guilds and will only be guaranteed to be updated after an hour. Guild commands update instantly. As such, we recommend you use guild-based commands during development and publish them to global commands when they're ready for public use. ~ https://discordjs.guide

# The `npm run deploy` command

The `npm run deploy` command will deploy the slash commands from your project to Discord. Upon running this command, it will ask you if you want to deploy the commands to the testing guild or globally.

> Do you want to deploy the commands globally? If yes, type "YES", otherwise don't type anything:

If you say "YES", the commands will be deployed globally, otherwise they will be deployed to the testing guild provided in the `configuration.json` file (`DISCORD_TESTING_GUILD_ID`).