Chuyển tới nội dung chính

FF RESTaurent Wiki

FF RESTaurent is a group bill-splitting and restaurant tracker: it helps a group manage shared bills from restaurants, split costs fairly between members, track who has paid, and surface spending statistics. This documentation is the operational and development reference for the platform — how to build on it, how to deploy it, and how to run it in production.

Start here: Backend Development and Frontend Development for working on the code, or the Production Runbook for operating the live service.

[!NOTE] Current state. Production runs v2.2.2 (2026-08-20). Staging (develop) has v2.3.0-rc.1 in progress; it is not in production yet.


Development​

DocumentWhat it covers
Backend DevelopmentWorking on the API in apps/api — Fastify 5, Prisma 6, PostgreSQL, request flow, validation, authorization, money rules, local setup, and checklist.
Frontend DevelopmentWorking on the web app in apps/web — React 19, React Router 7 loaders/actions, Vite 7, Tailwind, API client, session handling, and checklist.
OpenAPI DevelopmentUpdating and validating the runtime OpenAPI contract, generated web transport types, local Swagger interface, and CI drift gate.
Folder Structure ReviewA review of the monorepo layout with a proposed target structure and migration order.

Domain Contracts​

DocumentWhat it covers
Password and Session ContractPATCH /me/password rules and how User.sessionVersion invalidates previously issued tokens with 401 SESSION_INVALIDATED.
Phone Number ContractCanonical E.164 storage for Vietnamese mobile numbers — input forms, normalization, persistence, and backfill.

Deployment & Infrastructure​

DocumentWhat it covers
Deployment GuidePreparation and deployment steps — deployment targets, pre-deployment checklist, CI/CD pipelines, and production readiness.
FF-71 Supabase Storage DecisionDecision to keep Supabase Storage as the active media provider and defer GCS migration.
GCP FoundationRecovery-ready GCP foundation: resource inventory, secure apply procedure, workload identity federation, and boundaries.
GCP Migration PlanEnd-to-end plan for moving from Render to GCP: architecture, provisioning, phases, rollback, and cost estimates.
GCP Migration TimelineRecord of how the Phase 2.5 migration was executed, provisioning script, load balancing, container build fixes, and future deploy steps.
Database Migration PlaybookRender PostgreSQL → Cloud SQL for PostgreSQL: strategy, provisioning, execution, verification, cutover, rollback, and ongoing operations.

Runbooks & Operations​

DocumentWhat it covers
Production RunbookRelease gates, required configuration, session/token policy, deployment, launch telemetry, backups, and rollback rehearsal.
Push NotificationsConfiguring Firebase Cloud Messaging, testing browser delivery, Cloud Run runtime preparation, and troubleshooting.
Real-Time Notification InboxOperating the authenticated SSE stream that refreshes the in-app notification list and unread badge in real time.
Root Admin OperationsSingleton ROOT_ADMIN — bootstrap, in-app ownership transfer, and emergency operator recovery.
Password Recovery OperationsRoot-Admin-assisted password recovery via out-of-band identity checks without SMS/email.
Phase 2 Migration RunbookPhase 2 contract verification gate — deployment gate, post-deployment verification, and failure response.

Performance​

DocumentWhat it covers
FF-27 Optimization EvidenceDatabase index coverage across four query shapes, and web bundle delivery before and after chunk splitting.

Releases​

ReleaseDateSummary
v2.3.0-rc.1 (Staging)2026-09-19Staging release candidate: bill-created notifications and auto-archive, dining area detail editing, cuisine EN/VI names and images, meal-vote surveys and wheels, and Honor Badges. Not in production yet.
v2.2.22026-08-20Member cost formulas for bill splitting, mobile responsiveness across the app, and Docker Compose standardization.
v2.2.02026-08-02Real-time SSE notification stream, FCM push delivery, dining area media, custom accent themes, consolidated Settings, and automated verification.
v2.1.02026-07-30Phase 2.5/2B hardening: staging CI/CD, OpenAPI transport generation, filter/date improvements, avatars, and agent tooling.
v2.0.02026-07-26Major infrastructure shift — migration from Render to GCP (Cloud Run, Cloud SQL) and Cloudflare.
v1.1.02026-07-21Phase 2 implementation, FF-38 contract migration, Supabase media storage, and production evidence.
v1.1.0-RC—Release candidate procedure that preceded v1.1.0.
v1.0.02026-07-14Phase 1 launch scope — hardened auth/RBAC, settlement integrity, and payment workflows.

Archive​

DocumentWhat it covers
Original App SpecPre-implementation product brief: roles, permissions, data model, bill-splitting logic, and proposed build order.