PeakPOS Documentation

Internal documentation for the PeakPOS monorepo.

Canonical entry points. Local testing runs through scripts/test-local.sh (automated battery) and scripts/local-validation.sh (running-stack PR QA). These replaced the retired QA-ledger / coverage-matrix / obligation-rollup / findings-ledger workflow — do not reintroduce those as active gates. See Local Testing for the full command surface and qa/evidence-summary.md for report aggregation.

Retired surfaces. The peak-api microservice and the standalone PeakPro portal (apps/websites/portals/peakpro) have been removed. AI/agent runtime now lives in ai-api; former Peak account workflows terminate in management-api / merchant-api / tx-bundler; reusable portal code lives in apps/websites/portals/shared. See Peak Re-architecture for the durable owner map. Retired names should appear only in migration catalogs and guard tests.

Getting Started

• Operations Guide - Build, deploy, and run commands
• Local Testing - How to test locally
• Testing Guide - Testing patterns and conventions
• Pre-commit Setup - Pre-commit hook setup
• Database Reset - Database reset and schema reinstall procedures

Support Staff

• Merchant Onboarding - Onboard a new merchant in the Support Portal
• User Management - Invite users, manage roles, and remove access
• Terminal Provisioning - Provision terminals, monitor health, and troubleshoot offline devices

API Reference

• API Reference - Generated OpenAPI source-of-truth pointers
• Merchant API Contract - Merchant API generated-contract ownership
• IAM Contract - IAM executable spec and runtime ownership

Architecture & Development

• Endpoint Map - All service endpoints and consumer wiring
• Android Payment Interface - Android payment provider dispatch (PEAK_GATEWAY / CASH_ONLY × N62 / N92 / TapToPay)
• Demo Provisioning - Demo environment provisioning platform
• Account Tax Gateway Alignment - Tax ownership boundary between account surfaces and Gateway calculation
• Entitlement Simplification Target - Future entitlement and resolver simplification target
• Peak Re-architecture - Current retired Peak runtime/source-of-truth guard

Compliance

• Age Policy Matrix - US per-state age rules seeded into compliance_age_policies (audit trail + review cadence)

Security

• Security Audit - Security audit report
• Security Remediation - Remediation steps
• Penetration Test Report - Pentest findings

AI Bots

• Bot 1: Podcast Outreach
• Bot 2: Agent Badge Issuance
• Bot 3: Demo Booking
• Bot 4: Merchant Referral Tracking
• Bot 5: Compliance Brief

E2E Testing

• Playwright MCP Testing - Automated website testing with Claude
• Playwright Behavior Coverage Gaps - Current E2E coverage inventory