Jacquez

A friendly moderator for OSS repos

Prerequisites

• Node.js (version 20 or higher)
• GitHub App credentials
• Anthropic API key
• Smee.io channel (for local development)

Setup

1. Clone and Install

git clone https://github.com/antiwork/jacquez.git
cd jacquez
npm install

2. Configure Environment Variables

Copy the example environment file:

cp .env.example .env

Edit .env with your credentials.

3. GitHub App Setup

1. Create a GitHub App at https://github.com/settings/apps/new
2. Configure the following permissions:
   • Repository permissions:
     • Issues: Read & Write
     • Pull requests: Read & Write
     • Contents: Read (for loading CONTRIBUTING.md)
   • Subscribe to events:
     • Issues
     • Pull requests
     • Issue comments
3. Set webhook URL to your Smee.io channel
4. Download the private key and update GH_PRIVATE_KEY in .env

4. Get API Keys

• Anthropic API Key: Get from https://console.anthropic.com/
• Smee.io Channel: Create at https://smee.io/

Running the Server

Development Mode

npm start

The server will start on port 3000 and display:

GitHub App server is running on port 3000
Webhook URL: http://localhost:3000/webhook

Production Mode

For production deployment, ensure environment variables are set and run:

NODE_ENV=production npm start

Testing

Local Testing with Smee.io

1. Start the server: npm start
2. In another terminal, forward webhooks from Smee.io:

   npx smee-client --url https://smee.io/your_channel_id --path /webhook --port 3000

3. Test by:
   • Opening an issue in a repository where your app is installed
   • Opening a pull request
   • Commenting on an issue

License

This project is licensed under the MIT License.