A family housing management platform with a React web app, Python backend, Firebase Cloud Functions, and an Expo mobile app.
| Path | Description |
|---|---|
src/ |
React + Vite web application |
backend/ |
Python API (Render deployment) |
functions/ |
Firebase Cloud Functions |
mobile/ |
Expo (React Native) mobile app |
shared/ |
Shared utilities (web + mobile) |
public/ |
Static web assets |
tests/ |
Vitest unit tests and Playwright e2e |
docs/ |
Project documentation (see docs/README.md) |
npm install
cp .env.example .env.local # add your keys
npm run devBuild for production:
npm run buildSee backend/README.md and docs/setup/BACKEND_ENV_SETUP.md.
cd functions && npm installcd mobile && npm install
npm run startSee mobile/README.md.
All guides, setup notes, and archived status reports live under docs/:
- docs/setup/ — environment, APIs, integrations
- docs/deployment/ — Firebase, Render, AWS legacy
- docs/architecture/ — features and system design
- docs/testing/ — testing guides and checklists
- docs/troubleshooting/ — common fixes
- docs/archive/ — historical status reports and legacy AWS/Cognito docs
| Command | Description |
|---|---|
npm run dev |
Start Vite dev server |
npm run build |
Production build → dist/ |
npm test |
Vitest unit tests |
npm run test:e2e |
Playwright end-to-end tests |
firebase.json,firestore.rules,storage.rules— Firebaserender.yaml— backend on Rendervite.config.js— web bundler.env.example— template for local env vars (never commit real.envfiles)