API Glimpse

Traffic-based observe → inventory → risk: language/gateway connectors sample live traffic, API Glimpse cloud builds inventory, and the dashboard shows endpoints, schemas, and signals.

Brand: API Glimpse · dashboard app.apiglimpse.com · collector collect.apiglimpse.com · API api.apiglimpse.com.

Your app (or gateway)
  → Connector (samples + API key)
    → API Glimpse cloud (validate key, per-service aggregate)
  → Inventory store (schemas + signals — not raw bodies)
  → Dashboard (session auth)

Deploy — end-to-end Railway + Render + DNS + npm. Detail: RAILWAY.md, RENDER.md. Connector publish — npm / PyPI / Go / Maven / NuGet / gateways.

Quick start

Nick verifies manually — see docs/TESTING.md for the full step-by-step. Short local-dev notes: docs/DEPLOY.md#local-dev.

High level:

1. docker-compose up -d — Postgres + collector
2. Core + dashboard via npm run dev (marketing optional for app-only auth)
3. Create a project in the dashboard → copy API key into demo/app env only
4. Hit demo routes → inventory appears within seconds

Local dashboard (minimum)

# Once: copy env examples, install, migrate
cd backend && cp .env.example .env && npm install && npx prisma generate && npx prisma migrate deploy
cd ../frontend && cp .env.example .env && npm install

# Terminals
cd backend && npm run dev    # http://localhost:3001
cd frontend && npm run dev   # http://localhost:5173 — welcome + AuthModal

Both marketing and the dashboard open a tabbed AuthModal (Sign in | Create account). Marketing (:5174) is optional for local app-only auth; set VITE_API_URL=http://localhost:3001 on both when testing cross-origin cookies.

Repo layout

Path	Role
backend/	Core API: auth, projects, inventory reads (Express + Prisma)
ingest/	Ingest API: API-key upserts
frontend/	Dashboard (Vite + React + Tailwind v4) → Render → app.apiglimpse.com
marketing/	Marketing site (Vite + React) → Render → apiglimpse.com
docs-site/	Developer docs (VitePress) → Render → docs.apiglimpse.com
packages/middleware	Express SDK (@apiglimpse/middleware)
packages/fastify / nestjs / next	Other Node SDKs
packages/shared	Envelope + redaction helpers (@apiglimpse/shared)
packages/gateway-proxy	Node reverse-proxy sidecar
connectors/	Python, Go, Java, .NET, Nginx, Kong
agent/	Dockerized collector/processor
demo/*	Sample apps per connector
docker-compose.yml	Postgres + collector only

Docs

Customer-facing

• Integrating into an existing app — all connectors (canonical; also published via docs-site/)
• Connector publish — maintainer registry playbook
• Marketing site: marketing/ → apiglimpse.com
• Developer docs: docs-site/ → docs.apiglimpse.com

Internal / ops

• Deploy — production checklist (Railway, Render, DNS, npm, verify)
• npm publish — first-time publish of @apiglimpse/shared and @apiglimpse/middleware
• Railway — Postgres / ingest / collector / core detail
• Render — static dashboard, marketing, and docs sites
• Productization — product shape, phases, launch checklist
• SaaS plan — account/usage UX, Org→Project→Service, teams + RBAC
• Marketing — site IA, CTAs; brand API Glimpse
• Marketing GTM plan — positioning, ads, channels, multi-agent streams M0–M8; security-platform north star
• Marketing-ready product plan — dev streams R1–R6 to clear soft-launch / acquisition bar
• Nick’s next steps — single checklist: Resend, publish, Stripe, analytics, LinkedIn/Google
• Org plan-limit snapshots — catalog edits vs org entitlements
• Architecture — components and data flow
• Decisions — why these defaults
• Testing — manual verification checklist
• Protect mode — future opt-in blocking PM0–PM4; designed for later, not v0

Stack

Email/password + magic link, express-session + connect-pg-simple, Vite + React + Tailwind v4, Docker for infra, npm run dev for local app processes.