Overview
The Senchabot Monorepo is an open-source Discord and Twitch bot project that allows users to manage and enhance their Discord and Twitch channels. This project is designed to be easily customizable and extendable, allowing users to tailor the bot to their specific needs.
Features
- Discord Bot: Manage and enhance your Discord server with features such as moderation tools, custom commands, and event-driven functionality.
- Twitch Bot: Enhance your Twitch channel with features such as automated chat moderation, loyalty systems, and custom commands.
- Easy Installation: Simple installation process with step-by-step instructions for setting up the bot on your server.
- Customization: The bot is highly customizable, allowing users to easily add or modify features to suit their needs.
- Contributions: Contributions are welcomed, and users are encouraged to participate in the development of the bot.
Installation
To install the Senchabot Monorepo, follow these steps:
Prerequisites: Ensure that you have the following prerequisites installed on your system:
- Git
- Node.js 18 or higher
- npm
- Docker & Docker Compose
Clone the repo: Clone the Senchabot Monorepo repository to your local machine using the Git command:
git clone https://github.com/sencha-dev/senchabot-monorepo.git
Create .env files: Create
.env
files based on the exampleenv.example
files provided in the repository. These files contain configuration options for the bot.Install dependencies: Install the necessary dependencies by running the following command in the project directory:
npm install
Run turbo build: Build the application using the following command:
npm run turbo-build
Set up MySQL database: Set up a Docker container for the MySQL database by following the provided instructions.
Generate Prisma files and database: Generate the Prisma files and set up the database according to the documentation.
Run the bot: The bot is now ready to be run using the appropriate commands for Discord and Twitch. Refer to the documentation for detailed instructions.
Summary
The Senchabot Monorepo is an open-source Discord and Twitch bot project with a wide range of features and easy customization options. With a simple installation process and comprehensive documentation, users can quickly set up and tailor the bot to their needs. Contributions to the project are welcomed, further enhancing its functionality and flexibility.