Thank you for your interest in contributing to TeaClient Social Bots! We're excited to have you on board. This guide will walk you through everything you need to know to get started and contribute effectively to our project.
Before you begin, ensure you have the following:
- Basic knowledge of TypeScript, DiscordJS, Node.js, TurboRepo, and Bun.
- A Discord Application and Server.
- Bun installed. Note: If you're using Nix/NixOS, Bun is included in the environment setup.
Note: It's recommended to have a basic understanding of JavaScript before diving into TypeScript, as TypeScript is essentially JavaScript with types.
This project utilizes Bun as its package manager and build tool, chosen for its speed, simplicity, and compatibility with TypeScript.
For Nix/NixOS users, a full flake is included to streamline the setup process. You can either use direnv and allow it via direnv allow, or run:
nix develop --impureTo install all project dependencies using Bun, run:
bun installThere are two methods to run the bot:
- Running the bot separately: Navigate to the specific bot directory (e.g.,
cd bots/<bot>) and runbun dev. - Running all bots: Execute
bun devin the root directory to run all bots with TurboRepo.
We expect all contributors to adhere to our Code of Conduct. This document outlines our community standards and provides guidelines for participating in our project.
We'd like to thank all contributors & Team Members/Maintainers for their efforts and dedication. Your contributions are what make this project thrive.