Quickstart

From git clone to a tracked click in about five minutes. Argus Grape runs as four small services: a Go edge tracker, a Fastify API, the Next.js dashboard and a demo storefront.

1. Clone and start the infrastructure

shell

git clone https://github.com/your-org/argus.git
cd argus
docker compose up -d   # Postgres 16 (migrations auto-run on first boot) + Redis 7

Prefer running without Docker? brew install postgresql@16 redis works too — create an argus database and apply the files in db/migrations in order.

2. Install dependencies

shell

cd api && npm install
cd ../web && npm install

3. Seed demo data

The seed creates a demo campaign and a three-level affiliate tree, so the dashboard has something to show immediately.

shell

make seed

4. Start everything

shell

make start
# edge tracker  :8080
# API           :3001
# dashboard     :3000
# demo shop     :3002

Open http://localhost:3000/dashboard, grab a tracking link from a campaign and click it — the click lands in the dashboard within a second.

Environment variables

Variable	Used by	Description
`DATABASE_URL`	API	Postgres connection string. Defaults to the local argus database started by Docker Compose.
`REDIS_URL`	Edge + API	Redis holds rate-limit state, the destination cache and the click stream.
`STRIPE_WEBHOOK_SECRET`	API	Verifies the Stripe-Signature header on POST /webhooks/stripe.
`ZYLIOR_WEBHOOK_SECRET`	API	HMAC-SHA256 key for the x-zylior-signature header. Verification is skipped in dev when unset.
`NEXT_PUBLIC_ARGUS_API_URL`	Dashboard	Base URL of the management API. Default: http://localhost:3001.
`NEXT_PUBLIC_ARGUS_EDGE_URL`	Dashboard	Base URL of the edge tracker, used to build tracking links. Default: http://localhost:8080.
`NEXT_PUBLIC_ARGUS_MOCK`	Dashboard	"1" (default) serves simulated data; set to "0" to hit the real API.

Next steps

Read how tracking links attribute clicks, then wire your checkout to the conversion webhooks. For the why behind the architecture, read our articles.