Trystpilot Documentation

Trystpilot Documentation

Anonymous Romantic Relationship Reviews — developer and contributor reference.

---

Contents

Document	Description
CHANGELOG	Version history and release notes
ARCHITECTURE	System architecture — frontend, backend, DB, auth, caching, observability
DEVOPS	DevOps governance — branching, CI/CD, secrets, migrations, monitoring
SECURITY	Risk, liability, compliance — pre-launch gates, PII, CCPA/GDPR, incident response
README	Project overview and quick-start
CLAUDE.md	AI assistant instructions and platform spec
ROADMAP	Phased build-out plan, M1–M9 milestones, triage bugs, monetization
UX Journey Maps	User, Developer, and Admin experience flows with Mermaid diagrams
UI Design System
ui/INDEX.md	Component inventory, gap analysis, layout recommendations
ui/COMPONENTS.md	ASCII art for all 70 components (26 existing + 44 missing)
ui/FLOWS_1920x1080.md	6 flows × 3 layout variations at 1920×1080
ui/FLOWS_MOBILE.md	4 flows × 6 device sizes (375px → 1440px)
ui/DESIGN_TOKENS.md	Token system architecture (Penpot integration pending)

Design Diagrams (design/)

Mermaid diagrams for every system asset — renders natively on GitHub.

File	Asset
design/architecture/frontend.md	App Router page tree, component map, analytics layer
design/architecture/backend.md	API routes, service libs, DB/Redis/hCaptcha, known issues
design/architecture/infrastructure.md	Vercel/CF/Railway topology, env separation, secret registry
design/architecture/database.md	ER diagram, enum types, reputation formula, known bugs
design/product/user-flows.md	Reviewer, Reader, Subject journey flowcharts
design/product/roles-permissions.md	Role capability graph, permission table
design/product/monetization.md	Revenue tier model, timeline, quadrant chart
design/governance/moderation.md	Auto-filter pipeline, state machine, SLA table
design/governance/access-control.md	Permission hierarchy, security hardening checklist
design/business/revenue-model.md	Revenue timeline, unit economics, risk/mitigation matrix
design/devops/cicd.md	GitGraph branching model, CI/CD pipeline, versioning policy

---

Architecture Overview

trystpilot/
├── app/              # Next.js App Router pages and API routes
├── components/       # Shared React components
├── lib/              # Server-side utilities (db, moderation, reputation)
├── middleware.ts     # Edge middleware (rate limiting, moderation)
├── public/           # Static assets
└── docs/             # This documentation directory

Tech Stack

Layer	Technology
Frontend	Next.js 15, React 19, Tailwind CSS
Backend	Next.js API Routes (App Router)
Database	PostgreSQL
Rate Limiting	Upstash Redis
CAPTCHA	hCaptcha
i18n	Custom language packs (en, de, es, fr, pt)

Key Concepts

• First name + last initial + city — profiles are identified by partial name and city only; zip code used internally for deduplication, never displayed.
• Anonymous reviewers — hash-based fingerprinting, no accounts required.
• Reputation score — weighted average across six rating dimensions with recency decay.
• Moderation-first — all reviews pass automated text filtering before going live.
• Mermaid diagrams — mermaid package installed; all journey maps include flowcharts that render natively on GitHub/Gitea.

Development

npm install
cp .env.example .env.local   # fill in your credentials
npm run dev                  # http://localhost:3000

See README for full environment variable reference.