Files
WebHooker/docs/guide/getting-started.md
T
翅膀 5fcb129170 docs(worker): align guides with runtime behavior
Synchronize both language guides, API references and examples with
the implemented authorization, storage and delivery behavior.
Document migration requirements and accepted operational limits.
2026-10-23 23:24:05 +08:00

3.1 KiB

Getting Started

Prerequisites

Installation

git clone https://github.com/Elysola/WebHooker.git
cd WebHooker
bun 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_CLIENT_ID=your-client-id
GITHUB_CLIENT_SECRET=your-client-secret
DISCORD_TOKEN=your-bot-token
DISCORD_PUBLIC_KEY=your-public-key
ADMIN_USER_IDS=your-github-id
BASE_URL=http://localhost:8787

::: tip GITHUB_APP_ID / GITHUB_PRIVATE_KEY are only needed for the GitHub App install flow and API enrichment: without them only super admins can bind installations, because the flow cannot verify that a signed-in user manages the installation (the OAuth flow itself only needs the client ID/secret). Target channels are set per route in the Web UI, so no DISCORD_CHANNEL_ID is needed. To enable /gh commands locally, copy the Public Key from the Developer Portal into DISCORD_PUBLIC_KEY and set the Interactions Endpoint URL to http://localhost:8787/discord/interactions. :::

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

2. Start Dev Server

bun run db:migrate   # first run: apply the D1 migrations to the local database
bun run cf:dev       # build, then serve the worker with wrangler dev (Miniflare)

This serves the built worker at http://localhost:8787. Without the migrations the worker refuses to serve (D1 migrations are incomplete). For UI work, bun run dev starts the Nuxt dev server with HMR instead (http://localhost:3000; queue messages have no consumer there).

3. Verify

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

Available Scripts

Script Description
bun run dev Start Nuxt dev server (HMR)
bun run build Production build (cloudflare_module preset)
bun run deploy Apply pending D1 migrations and deploy
bun run typecheck TypeScript type checking
bun run lint ESLint
bun run lint:md Markdownlint
bun run format Format with Prettier
bun run format:check Check Prettier formatting
bun test Unit tests
bun run docs:dev Start docs dev server
bun run docs:build Build docs site