Skip to content

Repository files navigation

Planner

Planner MVP development workspace.

Directory

  • docs/architecture: product architecture and review documents
  • docs/schema: backend schema contract documents
  • docs/review: readiness checklist and review artifacts
  • infra/firebase: Firestore rules and index definitions
  • backend/functions: Firebase Functions codebase (TypeScript)
  • mobile/app: mobile app codebase (Expo + React Native)

Quick Start

  1. Use Node 24 (nvm use with .nvmrc).
  2. Set Firebase project id in .firebaserc.
  3. Install backend dependencies:
    • cd backend/functions && npm install
  4. Build backend:
    • npm run build
  5. Start emulator from repo root:
    • npx firebase-tools emulators:start --only firestore,functions,pubsub

Validation Gate

Run from repository root:

  1. npm run check:env
  2. npm run check:backend
  3. npm run check:mobile:typecheck
  4. npm run check:mobile:doctor
  5. npm run check:emulator
  6. npm run check:all (runs all checks in sequence)

Environment Requirements

  1. JDK 21+ is required by current Firebase emulator tooling.
  2. Local Node 24 is recommended to match Functions runtime.

Contract First

  • Product source of truth: docs/architecture/MVP_ARCHITECTURE_AND_REVIEW.md
  • Backend source of truth: docs/schema/BACKEND_SCHEMA_SPEC.md
  • Do not implement domain writes outside Functions API.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages