Skip to content

This is a Discord Bot template created in TypeScript, the key is that it is easy to manage!

License

Notifications You must be signed in to change notification settings

minagishl/discord-bot-typescript-template

Repository files navigation

Discord Bot TypeScript Template

This repository provides a template for creating a Discord bot using TypeScript. It is designed to be easy to manage and extend.

Features

  • TypeScript: Strongly typed language for building robust applications.
  • ESLint: Linting tool for identifying and fixing problems in the code.
  • Prettier: Code formatter to ensure a consistent style.
  • Vitest: Testing framework for ensuring code quality.
  • Docker: Containerization for easy deployment.

Getting Started

Prerequisites

  • Node.js
  • Yarn

Installation

  1. Clone the repository:

    git clone https://github.com/minagishl/discord-bot-typescript-template.git
    cd discord-bot-typescript-template
  2. Install dependencies:

    yarn install

Usage

  1. Create a .env file in the root directory and add your Discord bot token:

    DISCORD_TOKEN=your-token-here
  2. Start the bot:

    yarn start

Scripts

  • yarn start: Starts the bot.
  • yarn lint: Lints the code.
  • yarn format: Formats the code.
  • yarn test: Runs tests.

Project Structure

  • src/: Source code of the bot.
  • scripts/: Scripts for managing the project.
  • tests/: Unit and integration tests.

Contributing

  1. Fork the repository.
  2. Create your feature branch:
    git checkout -b feature/your-feature
  3. Commit your changes:
    git commit -m 'Add some feature'
  4. Push to the branch:
    git push origin feature/your-feature
  5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

  • Inspired by the community and contributors of TypeScript and Discord.js.

For more information, visit the repository.

About

This is a Discord Bot template created in TypeScript, the key is that it is easy to manage!

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published