Skip to content

minagishl/discord-bot-miibo-chat

Repository files navigation

Discord Bot Miibo Chat

This repository is a simple application that allows you to talk to Discord bots using TypeScript and Miibo

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-miibo-chat.git
    cd discord-bot-miibo-chat
  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

A chat bot built using miibo and running on Discord.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published