This repository provides a template for creating a Discord bot using TypeScript. It is designed to be easy to manage and extend.
- 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.
- Node.js
- Yarn
-
Clone the repository:
git clone https://github.com/minagishl/discord-bot-typescript-template.git cd discord-bot-typescript-template
-
Install dependencies:
yarn install
-
Create a
.env
file in the root directory and add your Discord bot token:DISCORD_TOKEN=your-token-here
-
Start the bot:
yarn start
yarn start
: Starts the bot.yarn lint
: Lints the code.yarn format
: Formats the code.yarn test
: Runs tests.
src/
: Source code of the bot.scripts/
: Scripts for managing the project.tests/
: Unit and integration tests.
- Fork the repository.
- Create your feature branch:
git checkout -b feature/your-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin feature/your-feature
- Open a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
- Inspired by the community and contributors of TypeScript and Discord.js.
For more information, visit the repository.