ShipSecure

Development

Set up Radar for local development

Prerequisites

  • Node.js 22+
  • pnpm 9+ (corepack enable && corepack prepare pnpm@9 --activate)
  • Docker (for Redis)
  • Anthropic or OpenAI API key

Getting started

Clone and install:

git clone https://github.com/shipsecure-labs/radar.git
cd radar
pnpm install

Start Redis:

docker compose -f docker-compose.dev.yml up -d

Configure environment:

cp .env.example .env

Edit .env with your API keys and at least one git provider (GitHub or GitLab).

Start the dev server:

pnpm dev

This starts both the gateway (port 3000) and the worker with hot-reload.

Scripts

ScriptDescription
pnpm devStart gateway + worker with hot-reload
pnpm buildBuild all packages
pnpm lintLint all packages
pnpm typecheckType check all packages
pnpm testRun tests
pnpm formatFormat with Prettier

Exposing your local server

During development, GitHub/GitLab needs to reach your local gateway. Use a tunnel:

# ngrok
ngrok http 3000

# Cloudflare Tunnel
cloudflared tunnel --url http://localhost:3000

Use the tunnel URL as your webhook URL:

  • GitHub: https://xxxx.ngrok.io/github/webhook
  • GitLab: https://xxxx.ngrok.io/gitlab/webhook

Self-Hosting

Deploy Radar with Docker Compose

On this page

PrerequisitesGetting startedScriptsExposing your local server