# nishantrajora/roomsync architecture

> Architecture diagram of the GitHub repository nishantrajora/roomsync, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nishantrajora/roomsync
- Repository: https://github.com/nishantrajora/roomsync

## Overview

ROOMSYNC is a student roommate-finding and co-living app. Students sign up or log in, build profiles, discover listings and compatible roommates, then use tools for safer visits and shared living. The main internal layer is AppContext, which coordinates application state and Firebase access. The README documents major safety, agreement, and co-living capabilities; some implementation details are not sampled, so those connections are shown only where documented or indexed.

Main entry points: [`src/App.tsx`](https://github.com/nishantrajora/roomsync/blob/main/src/App.tsx) (App router), [`src/context/AppContext.tsx`](https://github.com/nishantrajora/roomsync/blob/main/src/context/AppContext.tsx) (Shared app state), [`src/pages/MatchesPage.tsx`](https://github.com/nishantrajora/roomsync/blob/main/src/pages/MatchesPage.tsx) (Compatibility matches), [`src/pages/DiscoverPage.tsx`](https://github.com/nishantrajora/roomsync/blob/main/src/pages/DiscoverPage.tsx) (Room discovery)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["App entry"]
  node_app["App router<br/>[App.tsx]"]
  node_landing["Landing<br/>[LandingPage.tsx]"]
  node_auth["Authentication<br/>[AuthPage.tsx]"]
  node_onboarding["Onboarding"]
end

subgraph group_discovery["Discovery and trust"]
  node_discover["Room discovery<br/>[DiscoverPage.tsx]"]
  node_matches["Compatibility matches<br/>[MatchesPage.tsx]"]
  node_radar["Compatibility radar"]
  node_trust["Listing trust scoring<br/>[trust.ts]"]
  node_scoring["Compatibility scoring<br/>[scoring.ts]"]
end

subgraph group_safety["Safety tools"]
  node_safety_map["Safety map<br/>[SafetyMapPage.tsx]"]
  node_visit_checkin["Visit check-in"]
  node_agreement["Agreement analyzer"]
  node_nlp["Clause analysis<br/>[nlp.ts]"]
end

subgraph group_coliving["Co-living management"]
  node_pact["Roommate pact"]
  node_bills["Bill splitting"]
  node_settlement["Expense settlement<br/>[settlement.ts]"]
  node_reviews["Landlord reviews<br/>[ReviewsPage.tsx]"]
  node_messages["Messaging<br/>[MessagesPage.tsx]"]
end

subgraph group_shared["Shared application layer"]
  node_profile["Profile management<br/>[ProfilePage.tsx]"]
  node_shell["App shell<br/>[AppShell.tsx]"]
  node_context["Shared app state<br/>[AppContext.tsx]"]
  node_firebase["Firebase access<br/>[firebase.ts]"]
  node_seed["Seed data<br/>[seedData.ts]"]
end

node_student(("Student"))
node_leaflet["Leaflet maps<br/>external library"]
node_firestore[("Firestore")]

node_student -->|"opens app"| node_app
node_app -->|"provides state"| node_context
node_app -->|"routes public"| node_landing
node_app -->|"routes login"| node_auth
node_app -->|"renders dashboard"| node_shell
node_app -->|"routes tab"| node_discover
node_app -->|"routes tab"| node_matches
node_app -->|"routes tab"| node_safety_map
node_app -->|"routes tab"| node_agreement
node_app -->|"routes tab"| node_pact
node_app -->|"routes tab"| node_bills
node_app -->|"routes tab"| node_reviews
node_app -->|"routes tab"| node_messages
node_app -->|"routes tab"| node_profile
node_auth -->|"uses state"| node_context
node_onboarding -->|"uses state"| node_context
node_discover -->|"uses state"| node_context
node_discover -->|"scores listings"| node_trust
node_matches -->|"uses state"| node_context
node_matches -->|"opens comparison"| node_radar
node_matches -->|"calculates compatibility"| node_scoring
node_safety_map -->|"uses state"| node_context
node_visit_checkin -->|"uses state"| node_context
node_agreement -->|"uses state"| node_context
node_agreement -->|"analyzes clauses"| node_nlp
node_pact -->|"uses state"| node_context
node_bills -->|"uses state"| node_context
node_bills -->|"calculates settlement"| node_settlement
node_reviews -->|"uses state"| node_context
node_messages -->|"uses state"| node_context
node_profile -->|"uses state"| node_context
node_shell -->|"reads app state"| node_context
node_context -->|"uses Firebase"| node_firebase
node_firebase -->|"reads and writes"| node_firestore
node_context -->|"loads initial data"| node_seed
node_safety_map -.->|"visualizes locality safety"| node_leaflet

click node_app "https://github.com/nishantrajora/roomsync/blob/main/src/App.tsx"
click node_landing "https://github.com/nishantrajora/roomsync/blob/main/src/pages/LandingPage.tsx"
click node_auth "https://github.com/nishantrajora/roomsync/blob/main/src/pages/AuthPage.tsx"
click node_onboarding "https://github.com/nishantrajora/roomsync/blob/main/src/components/onboarding/OnboardingModal.tsx"
click node_discover "https://github.com/nishantrajora/roomsync/blob/main/src/pages/DiscoverPage.tsx"
click node_matches "https://github.com/nishantrajora/roomsync/blob/main/src/pages/MatchesPage.tsx"
click node_radar "https://github.com/nishantrajora/roomsync/blob/main/src/components/matching/RadarChartModal.tsx"
click node_trust "https://github.com/nishantrajora/roomsync/blob/main/src/lib/trust.ts"
click node_scoring "https://github.com/nishantrajora/roomsync/blob/main/src/lib/scoring.ts"
click node_safety_map "https://github.com/nishantrajora/roomsync/blob/main/src/pages/SafetyMapPage.tsx"
click node_visit_checkin "https://github.com/nishantrajora/roomsync/blob/main/src/components/common/SosCheckinModal.tsx"
click node_agreement "https://github.com/nishantrajora/roomsync/blob/main/src/pages/AgreementAnalyzerPage.tsx"
click node_nlp "https://github.com/nishantrajora/roomsync/blob/main/src/lib/nlp.ts"
click node_pact "https://github.com/nishantrajora/roomsync/blob/main/src/pages/RoommatePactPage.tsx"
click node_bills "https://github.com/nishantrajora/roomsync/blob/main/src/pages/BillSplitterPage.tsx"
click node_settlement "https://github.com/nishantrajora/roomsync/blob/main/src/lib/settlement.ts"
click node_reviews "https://github.com/nishantrajora/roomsync/blob/main/src/pages/ReviewsPage.tsx"
click node_messages "https://github.com/nishantrajora/roomsync/blob/main/src/pages/MessagesPage.tsx"
click node_profile "https://github.com/nishantrajora/roomsync/blob/main/src/pages/ProfilePage.tsx"
click node_shell "https://github.com/nishantrajora/roomsync/blob/main/src/components/layout/AppShell.tsx"
click node_context "https://github.com/nishantrajora/roomsync/blob/main/src/context/AppContext.tsx"
click node_firebase "https://github.com/nishantrajora/roomsync/blob/main/src/lib/firebase.ts"
click node_seed "https://github.com/nishantrajora/roomsync/blob/main/src/data/seedData.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_landing,node_auth,node_onboarding toneBlue
class node_discover,node_matches,node_radar,node_trust,node_scoring,node_firestore toneAmber
class node_safety_map,node_visit_checkin,node_agreement,node_nlp toneMint
class node_pact,node_bills,node_settlement,node_reviews,node_messages toneRose
class node_profile,node_shell,node_context,node_firebase,node_seed,node_student,node_leaflet toneIndigo
```

## Components

### App entry

- [App router](https://github.com/nishantrajora/roomsync/blob/main/src/App.tsx): `src/App.tsx`
- [Landing](https://github.com/nishantrajora/roomsync/blob/main/src/pages/LandingPage.tsx): `src/pages/LandingPage.tsx`
- [Authentication](https://github.com/nishantrajora/roomsync/blob/main/src/pages/AuthPage.tsx): `src/pages/AuthPage.tsx`
- [Onboarding](https://github.com/nishantrajora/roomsync/blob/main/src/components/onboarding/OnboardingModal.tsx): `src/components/onboarding/OnboardingModal.tsx`

### Discovery and trust

- [Room discovery](https://github.com/nishantrajora/roomsync/blob/main/src/pages/DiscoverPage.tsx): `src/pages/DiscoverPage.tsx`
- [Compatibility matches](https://github.com/nishantrajora/roomsync/blob/main/src/pages/MatchesPage.tsx): `src/pages/MatchesPage.tsx`
- [Compatibility radar](https://github.com/nishantrajora/roomsync/blob/main/src/components/matching/RadarChartModal.tsx): `src/components/matching/RadarChartModal.tsx`
- [Listing trust scoring](https://github.com/nishantrajora/roomsync/blob/main/src/lib/trust.ts): `src/lib/trust.ts`
- [Compatibility scoring](https://github.com/nishantrajora/roomsync/blob/main/src/lib/scoring.ts): `src/lib/scoring.ts`

### Safety tools

- [Safety map](https://github.com/nishantrajora/roomsync/blob/main/src/pages/SafetyMapPage.tsx): `src/pages/SafetyMapPage.tsx`
- [Visit check-in](https://github.com/nishantrajora/roomsync/blob/main/src/components/common/SosCheckinModal.tsx): `src/components/common/SosCheckinModal.tsx`
- [Agreement analyzer](https://github.com/nishantrajora/roomsync/blob/main/src/pages/AgreementAnalyzerPage.tsx): `src/pages/AgreementAnalyzerPage.tsx`
- [Clause analysis](https://github.com/nishantrajora/roomsync/blob/main/src/lib/nlp.ts): `src/lib/nlp.ts`

### Co-living management

- [Roommate pact](https://github.com/nishantrajora/roomsync/blob/main/src/pages/RoommatePactPage.tsx): `src/pages/RoommatePactPage.tsx`
- [Bill splitting](https://github.com/nishantrajora/roomsync/blob/main/src/pages/BillSplitterPage.tsx): `src/pages/BillSplitterPage.tsx`
- [Expense settlement](https://github.com/nishantrajora/roomsync/blob/main/src/lib/settlement.ts): `src/lib/settlement.ts`
- [Landlord reviews](https://github.com/nishantrajora/roomsync/blob/main/src/pages/ReviewsPage.tsx): `src/pages/ReviewsPage.tsx`
- [Messaging](https://github.com/nishantrajora/roomsync/blob/main/src/pages/MessagesPage.tsx): `src/pages/MessagesPage.tsx`

### Shared application layer

- [Profile management](https://github.com/nishantrajora/roomsync/blob/main/src/pages/ProfilePage.tsx): `src/pages/ProfilePage.tsx`
- [App shell](https://github.com/nishantrajora/roomsync/blob/main/src/components/layout/AppShell.tsx): `src/components/layout/AppShell.tsx`
- [Shared app state](https://github.com/nishantrajora/roomsync/blob/main/src/context/AppContext.tsx): `src/context/AppContext.tsx`
- [Firebase access](https://github.com/nishantrajora/roomsync/blob/main/src/lib/firebase.ts): `src/lib/firebase.ts`
- [Seed data](https://github.com/nishantrajora/roomsync/blob/main/src/data/seedData.ts): `src/data/seedData.ts`

### Other components

- **Student**
- **Leaflet maps**: external library
- **Firestore**

## Connections

- Student → App router: opens app (evidence: `src/App.tsx`)
- App router → Shared app state: provides state (evidence: `src/App.tsx`)
- App router → Landing: routes public (evidence: `src/App.tsx`)
- App router → Authentication: routes login (evidence: `src/App.tsx`)
- App router → App shell: renders dashboard (evidence: `src/App.tsx`)
- App router → Room discovery: routes tab (evidence: `src/App.tsx`)
- App router → Compatibility matches: routes tab (evidence: `src/App.tsx`)
- App router → Safety map: routes tab (evidence: `src/App.tsx`)
- App router → Agreement analyzer: routes tab (evidence: `src/App.tsx`)
- App router → Roommate pact: routes tab (evidence: `src/App.tsx`)
- App router → Bill splitting: routes tab (evidence: `src/App.tsx`)
- App router → Landlord reviews: routes tab (evidence: `src/App.tsx`)
- App router → Messaging: routes tab (evidence: `src/App.tsx`)
- App router → Profile management: routes tab (evidence: `src/App.tsx`)
- Authentication → Shared app state: uses state (evidence: `src/pages/AuthPage.tsx`)
- Onboarding → Shared app state: uses state (evidence: `src/components/onboarding/OnboardingModal.tsx`)
- Room discovery → Shared app state: uses state (evidence: `src/pages/DiscoverPage.tsx`)
- Room discovery → Listing trust scoring: scores listings (evidence: `src/pages/DiscoverPage.tsx`)
- Compatibility matches → Shared app state: uses state (evidence: `src/pages/MatchesPage.tsx`)
- Compatibility matches → Compatibility radar: opens comparison (evidence: `src/pages/MatchesPage.tsx`)
- Compatibility matches → Compatibility scoring: calculates compatibility (evidence: `src/pages/MatchesPage.tsx`)
- Safety map → Shared app state: uses state (evidence: `src/pages/SafetyMapPage.tsx`)
- Visit check-in → Shared app state: uses state (evidence: `src/components/common/SosCheckinModal.tsx`)
- Agreement analyzer → Shared app state: uses state (evidence: `src/pages/AgreementAnalyzerPage.tsx`)
- Agreement analyzer → Clause analysis: analyzes clauses (evidence: `src/pages/AgreementAnalyzerPage.tsx`)
- Roommate pact → Shared app state: uses state (evidence: `src/pages/RoommatePactPage.tsx`)
- Bill splitting → Shared app state: uses state (evidence: `src/pages/BillSplitterPage.tsx`)
- Bill splitting → Expense settlement: calculates settlement (evidence: `src/pages/BillSplitterPage.tsx`)
- Landlord reviews → Shared app state: uses state (evidence: `src/pages/ReviewsPage.tsx`)
- Messaging → Shared app state: uses state (evidence: `src/pages/MessagesPage.tsx`)
- Profile management → Shared app state: uses state (evidence: `src/pages/ProfilePage.tsx`)
- App shell → Shared app state: reads app state (evidence: `src/components/layout/AppShell.tsx`)
- Shared app state → Firebase access: uses Firebase (evidence: `src/context/AppContext.tsx`)
- Firebase access → Firestore: reads and writes (evidence: `src/lib/firebase.ts`)
- Shared app state → Seed data: loads initial data (evidence: `src/context/AppContext.tsx`)
- Safety map → Leaflet maps: visualizes locality safety (evidence: `README.md`)
