Developer Setup Guide

This guide will help you set up a local development environment for the Community Signal Moderation Bot.

Prerequisites

• Node.js (v18 or higher)
• Docker and Docker Compose
• pnpm

1. Clone the Repository

git clone https://github.com/your-username/Community-Signal-Moderation-Bot.git
cd Community-Signal-Moderation-Bot

2. Install Dependencies

Install the project dependencies using pnpm:

pnpm install

3. Set up the Database and Redis

The bot requires a PostgreSQL database and a Redis cache. You can start these services using Docker Compose:

docker compose up -d postgres redis

4. Configure Environment Variables

Copy the .env.example file to .env:

cp .env.example .env

Now, open the .env file and fill in the required environment variables. For local development, you will need to set the following variables:

• DATABASE_URL
• REDIS_URL
• BOT_NUMBER
• SIGNAL_CLI_CONFIG_PATH

5. Run the Bot

You can run the bot in development mode using the following command:

pnpm dev

This will start the bot and automatically restart it when you make changes to the code.

6. Running Tests

To run the tests, use the following command:

pnpm test