fellipeutaka/discord-bot-template

🤖 A Discord bot boilerplate including TypeScript and ESLint

Discord Bot Template

Project | Technologies | How to use | How to contribute | License

💻 Project

A boilerplate for a project with Discord.js, TypeScript and ESLint.

🚀 Technologies

This project was developed with the following technologies:

• TypeScript
• discord.js
• ESLint
• Prettier

ℹ️ How To Use

To clone and run this application, first you need to create a Discord Bot. Afterwards, you will need Git and Node.js installed on your computer.

From your command line:

# Clone this repository
$ git clone https://github.com/fellipeutaka/discord-bot-template.git

# Install dependencies
# If you are using NPM
$ npm install

# If you are using Yarn
$ yarn install

# If you are using PNPM
$ pnpm install

After that, copy and paste the .env.example file and rename it to .env. Then insert your Discord Token and Discord Client ID. Great! Now you just need to start the development server.

# Start server
# If you are using NPM
$ npm run dev
# If you are using Yarn
$ yarn dev
# If you are using PNPM
$ pnpm dev

🤔 How to contribute

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name> .
3. Make your changes and commit them: git commit -m '<commit_message> '
4. Push to original branch:git push origin <project_name> / <local>
5. Create the pull request. Or, see the GitHub documentation on how to create a pull request.

📝 License

This project is under the MIT license. See the LICENSE for details.

Made with ♥ by Fellipe Utaka 👋 Get in touch!