Skip to content

API Usage

This project does not use a custom API or backend server. All data access is handled directly via Firestore (see FIRESTORE_SCHEMA.md).


Backend

  • The only backend used is Firestore (Firebase Cloud Firestore).
  • There are no REST, GraphQL, or custom API endpoints.
  • All data operations (read, write, update, delete) are performed using the Firestore SDK from the frontend.

Data Access

  • Use the centralized Firestore refs in firestoreRefs.ts for all Firestore access.
  • Always handle errors and loading states in the UI.

Authentication

  • All Firestore access is protected by Firebase Auth and Firestore security rules.
  • Only authenticated users can access private data as allowed by security rules.

Adding New Data Models

  • Add new collections/fields in firestoreRefs.ts and update types in src/types/.
  • Update Firestore security rules as needed.

Best Practices

  • Use centralized refs and types for all data access.
  • Validate all input on the frontend before writing to Firestore.
  • Handle errors gracefully in the UI.
  • Document all new data shapes in FIRESTORE_SCHEMA.md.

For more, see FIRESTORE_SCHEMA.md and ARCHITECTURE.md or ask a maintainer.

Internal docs — access restricted via Cloudflare Zero Trust.