RastrackDash student self-host template

Documentação do aluno (pt-BR): README.pt-BR.md

nod-rastrackdash-wpp is a self-hosted, multi-tenant dashboard for agencies that run WhatsApp lead campaigns with Meta Ads. It brings together campaign performance, WhatsApp leads, conversion events, and operational diagnostics.

Status

Student edition F3–F6.2 landed on this public template (sanitized export of private WppTrack):

• License client (activate / heartbeat / status UI) — fail-closed: without a valid activation, reads stay open and every write answers 423
• WhatsApp multi-provider registry: uazapi_byo, nod_api (PalmUP broker), waha, zapi (Z-API: "Em breve", no ad-lead parsing yet)
• Inbound webhook parsers (Umbler, Gupshup, WAHA; Z-API is "Em breve")
• Disconnect alerts (optional webhook)
• Student backoffice (no PalmUP billing) + read-only license tab
• Env-driven whitelabel with fixed residual footer (RastrackDash · powered by PalmUP)

PalmUP's license server, Guru, and Asaas billing stay private and are not in this repository.

Quick start

Prerequisites: Node.js 20+, pnpm, Docker, and Docker Compose.

pnpm setup
# or step-by-step:
pnpm install
docker compose up -d postgres redis
cp .env.example .env   # if setup did not already create it
# fill replace-me-* and LICENSE_* in .env
pnpm --filter @wpptrack/api prisma:generate
pnpm --filter @wpptrack/api exec prisma migrate deploy --schema apps/api/prisma/schema.prisma

Optional first admin (if supported by your checkout):

export [email protected]
export SETUP_ADMIN_PASSWORD='a-strong-password'
pnpm setup
# or create-user path printed by setup

Start the API and web app in separate terminals:

pnpm --filter @wpptrack/api dev
pnpm --filter @wpptrack/web dev

Defaults: web http://localhost:3000, API http://localhost:3333.

Verify: open /backoffice (onboarding checklist), /backoffice/license, /integrations.

Bring your own services

• SMTP for email delivery
• WhatsApp: Uazapi BYO, WAHA (GoWS engine, your own server) and/or WhatsApp Cloud API (NOD API and Z-API are "Em breve": existing connections only, and Z-API does not yet receive ad leads)
• Meta System User access token (manual)
• Optional brand: BRAND_NAME, BRAND_LOGO_URL, BRAND_FAVICON_URL, BRAND_PRIMARY_COLOR

Security

• Never commit your .env file.
• Replace and rotate every replace-me-* placeholder before deploying.
• Keep service credentials and Meta tokens on the server; do not expose them to the frontend.
• Never remove the residual footer brands.

Documentation

• Changelog
• Acceptance matrix v1
• How to tag v1.0.0 (human gate — not automatic)
• PalmUP license ops runbook
• Student edition design spec
• Implementation plan
• Guide for AI agents · root AGENTS.md
• Setup guides
• Customization guide