Getting Started

Prerequisites

• Node.js 18+
• A Cloudflare account (free tier works)
• A GitHub App (see GitHub App Setup)
• A Discord bot token (see Discord Bot Setup)

Installation

git clone https://github.com/ReCloudStudio/WebHooker.git
cd WebHooker
npm install

Local Development

1. Configure Secrets

Copy the example env file and fill in your secrets:

cp .env.example .dev.vars

Edit .dev.vars with your actual values:

GITHUB_WEBHOOK_SECRET=your-webhook-secret
GITHUB_APP_ID=your-app-id
GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
GITHUB_CLIENT_ID=your-client-id
GITHUB_CLIENT_SECRET=your-client-secret
DISCORD_TOKEN=your-bot-token
DISCORD_CHANNEL_ID=your-channel-id
BASE_URL=http://localhost:8787

WARNING

.dev.vars is gitignored and contains secrets. Never commit it.

2. Start Dev Server

npm run dev

This starts a local Miniflare environment at http://localhost:8787.

3. Verify

curl http://localhost:8787/health
# → {"status":"ok"}

Available Scripts

Script	Description
npm run dev	Start local dev server (wrangler)
npm run deploy	Deploy to Cloudflare
npm run typecheck	TypeScript type checking
npm run lint	ESLint
npm run lint:md	Markdownlint
npm run format	Format with Prettier
npm run format:check	Check Prettier formatting
npm run docs:dev	Start docs dev server
npm run docs:build	Build docs site