Family Media

Private family social network — mobile-first app for sharing photos, chatting, and exploring your family tree.

Project structure

Family-Media/
├── api/          # NestJS backend (PostgreSQL + Redis)
├── mobile/       # Expo React Native app (iOS + Android)
├── docs/         # Design docs
└── docker-compose.yml

Prerequisites

• Node.js 20+ (LTS recommended)
• Docker Desktop
• iOS Simulator (Mac) or Android Emulator for mobile dev

Quick start

1. Start databases

docker compose up -d

This starts PostgreSQL (localhost:5432) and Redis (localhost:6379).

2. Configure environment

cp .env.example api/.env
cp mobile/.env.example mobile/.env

3. API setup

cd api
npm install
npm run prisma:migrate:deploy
npm run start:dev

API runs at http://localhost:3000

• GET / — API info
• GET /health — health check (database + redis)

4. Mobile app

cd mobile
npm install
npm run start

Press i for iOS simulator or a for Android emulator.

The Home tab pings GET /health and shows OK when the API and databases are up.

Android emulator note

The app defaults to http://10.0.2.2:3000 on Android. For a physical device, set your machine's LAN IP in mobile/.env:

EXPO_PUBLIC_API_URL=http://192.168.x.x:3000

Root scripts

From the repo root:

Command	Description
npm run docker:up	Start Postgres + Redis
npm run docker:down	Stop containers
npm run api:dev	Start API in watch mode
npm run mobile:dev	Start Expo dev server
npm run db:migrate	Run Prisma migrations (dev)
npm run db:deploy	Deploy migrations (prod/CI)

Phase 0 exit criteria

• docker compose up starts Postgres + Redis
• GET /health returns database + redis status
• Mobile Home tab shows API health
• Empty Prisma migration runs cleanly

Phase 1 exit criteria

• Phone OTP auth (POST /auth/otp/send, POST /auth/otp/verify) — OTP stored in Redis; OTP_DEV_MODE returns devOtp
• Profile GET/PATCH /users/me
• Create family + invite code / QR (POST /families, invite screen)
• Admin invite by phone stub (POST /families/:id/invites)
• Join via code → pending join_requests visible to admin (POST /join-requests, GET /families/:id/join-requests)

Phase 2 exit criteria

• Founding admin becomes root person on family create
• Placement onboarding (POST /join-requests/:id/onboarding) — parent required; spouse/siblings optional; placeholders supported
• Admin approve/reject (POST /join-requests/:id/approve|reject) commits tree edges
• GET /families/:id/tree + GET /persons/:id lineage summary
• Mobile Tree tab + join-request approve UI

Roadmap

See family_app_schema_design_a780f16f.plan.md for the full phased roadmap.

Next: Phase 3 — feed (posts, media, reactions, comments).