# gikeeeeeee/cs361_g06 architecture

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

- Interactive diagram: https://gitdiagram.com/gikeeeeeee/cs361_g06
- Repository: https://github.com/gikeeeeeee/cs361_g06

## Overview

Smart Faculty Navigator is a read-only campus place-information app: users discover buildings, inspect floors and plans, then look up rooms or facilities. The frontend routes pages and loads domain data through a campus-service abstraction; the backend routes API requests to use cases and an S3-backed data source. The README also describes bilingual place details and external map integration. Some frontend components and service implementations were not excerpted, so uncertain links are omitted; the service selector is explicitly configured to use mock data.

Main entry points: [`backend/handler.py`](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/handler.py) (Request router), [`frontend/src/App.tsx`](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/App.tsx) (Route application), [`backend/services/floor_service.py`](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/services/floor_service.py) (Floor use case), [`frontend/src/services/index.ts`](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/services/index.ts) (Campus service selector)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_discovery["Place discovery"]
  node_app["Route application<br/>[App.tsx]"]
  node_home_page["Home page<br/>[HomePage.tsx]"]
  node_map_ui["Campus map UI"]
  node_map_filter["Map filtering<br/>[useMapFilter.ts]"]
  node_map_types["Directory types"]
end

subgraph group_details["Place details"]
  node_building_page["Building page"]
  node_building_content["Building details UI<br/>[BuildingHero.tsx]"]
  node_building_hook["Building loader"]
  node_floor_viewer["Floor plan viewer"]
  node_room_page["Room page<br/>[RoomDetailPage.tsx]"]
  node_room_data["Room detail UI<br/>[RoomHero.tsx]"]
  node_room_hook["Room loader<br/>[useRoomDetail.ts]"]
  node_facility_page["Facility page"]
  node_facility_hook["Facility loader"]
end

subgraph group_frontend_data["Frontend data"]
  node_campus_service["Campus service selector<br/>[index.ts]"]
  node_campus_api["Campus API adapter<br/>[campus.api.ts]"]
  node_api_client["HTTP client<br/>[apiClient.ts]"]
  node_api_contracts["API contracts<br/>[api.contracts.ts]"]
end

subgraph group_backend["Backend API"]
  node_backend_handler["Request router<br/>[handler.py]"]
  node_building_service["Building use case"]
  node_floor_service["Floor use case<br/>[floor_service.py]"]
  node_room_service["Room use case<br/>[room_service.py]"]
  node_facility_service["Facility use case"]
  node_building_model["Building model<br/>[building.py]"]
  node_floor_model["Floor model<br/>[floor.py]"]
  node_room_model["Room model<br/>[room.py]"]
  node_facility_model["Facility model<br/>[facility.py]"]
end

subgraph group_storage["Data access"]
  node_source_port["Building data port<br/>[building_source.py]"]
  node_repository["S3 repository"]
end

node_user(("Campus user"))
node_map_service["Map service"]
node_s3[("Amazon S3")]

node_user -->|"opens"| node_app
node_app -->|"routes to"| node_home_page
node_app -->|"routes to"| node_building_page
node_app -->|"routes to"| node_room_page
node_app -->|"routes to"| node_facility_page
node_home_page -->|"renders"| node_map_ui
node_home_page -->|"uses"| node_map_filter
node_map_filter -->|"queries"| node_campus_service
node_map_filter -->|"uses types"| node_map_types
node_map_service -.->|"map integration"| node_map_ui
node_building_page -->|"loads data"| node_building_hook
node_building_page -->|"renders"| node_building_content
node_building_hook -->|"fetches building and floor"| node_campus_service
node_building_page -.->|"floor plan display"| node_floor_viewer
node_room_page -->|"loads data"| node_room_hook
node_room_page -->|"renders"| node_room_data
node_room_hook -->|"fetches room"| node_campus_service
node_facility_page -->|"loads data"| node_facility_hook
node_facility_hook -->|"fetches facility"| node_campus_service
node_campus_service -->|"selects adapter"| node_campus_api
node_campus_api -.->|"HTTP requests"| node_api_client
node_api_client -.->|"returns typed data"| node_api_contracts
node_backend_handler -->|"dispatches building routes"| node_building_service
node_backend_handler -->|"dispatches floor routes"| node_floor_service
node_backend_handler -->|"dispatches room routes"| node_room_service
node_backend_handler -->|"dispatches facility routes"| node_facility_service
node_backend_handler -->|"wires source"| node_repository
node_building_service -->|"reads data"| node_source_port
node_floor_service -->|"reads floor and plan"| node_source_port
node_floor_service -->|"locates floor"| node_floor_model
node_floor_service -->|"projects room pins"| node_room_model
node_floor_service -->|"projects facility pins"| node_facility_model
node_room_service -->|"reads building data"| node_source_port
node_room_service -->|"finds room"| node_room_model
node_facility_service -->|"reads data and plan URL"| node_source_port
node_facility_service -->|"finds facility"| node_facility_model
node_repository -->|"reads JSON and signs URLs"| node_s3

click node_app "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/App.tsx"
click node_home_page "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/pages/HomePage.tsx"
click node_map_ui "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/homepage/components/CampusMapContainer.tsx"
click node_map_filter "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/homepage/hooks/useMapFilter.ts"
click node_map_types "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/homepage/types/mapDirectory.types.ts"
click node_building_page "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/pages/BuildingDetailPage.tsx"
click node_building_content "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/building-info/components/BuildingHero.tsx"
click node_building_hook "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/building-info/hooks/useBuildingDetails.ts"
click node_floor_viewer "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/floor-viewer/components/FloorPlanContainer.tsx"
click node_room_page "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/pages/RoomDetailPage.tsx"
click node_room_data "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/room-detail/components/RoomHero.tsx"
click node_room_hook "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/room-detail/hooks/useRoomDetail.ts"
click node_facility_page "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/pages/FacilityDetailPage.tsx"
click node_facility_hook "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/room-detail/hooks/useFacilityDetail.ts"
click node_campus_service "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/services/index.ts"
click node_campus_api "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/services/campus.api.ts"
click node_api_client "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/services/api/apiClient.ts"
click node_api_contracts "https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/shared/types/api.contracts.ts"
click node_backend_handler "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/handler.py"
click node_building_service "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/services/building_service.py"
click node_floor_service "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/services/floor_service.py"
click node_room_service "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/services/room_service.py"
click node_facility_service "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/services/facility_service.py"
click node_building_model "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/models/building.py"
click node_floor_model "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/models/floor.py"
click node_room_model "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/models/room.py"
click node_facility_model "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/models/facility.py"
click node_source_port "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/ports/building_source.py"
click node_repository "https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/repositories/building_repository.py"

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_home_page,node_map_ui,node_map_filter,node_map_types,node_user toneBlue
class node_building_page,node_building_content,node_building_hook,node_floor_viewer,node_room_page,node_room_data,node_room_hook,node_facility_page,node_facility_hook,node_s3 toneAmber
class node_campus_service,node_campus_api,node_api_client,node_api_contracts toneMint
class node_backend_handler,node_building_service,node_floor_service,node_room_service,node_facility_service,node_building_model,node_floor_model,node_room_model,node_facility_model toneRose
class node_source_port,node_repository,node_map_service toneIndigo
```

## Components

### Place discovery

- [Route application](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Home page](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/pages/HomePage.tsx): `frontend/src/pages/HomePage.tsx`
- [Campus map UI](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/homepage/components/CampusMapContainer.tsx): `frontend/src/features/homepage/components/CampusMapContainer.tsx`
- [Map filtering](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/homepage/hooks/useMapFilter.ts): `frontend/src/features/homepage/hooks/useMapFilter.ts`
- [Directory types](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/homepage/types/mapDirectory.types.ts): `frontend/src/features/homepage/types/mapDirectory.types.ts`

### Place details

- [Building page](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/pages/BuildingDetailPage.tsx): `frontend/src/pages/BuildingDetailPage.tsx`
- [Building details UI](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/building-info/components/BuildingHero.tsx): `frontend/src/features/building-info/components/BuildingHero.tsx`
- [Building loader](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/building-info/hooks/useBuildingDetails.ts): `frontend/src/features/building-info/hooks/useBuildingDetails.ts`
- [Floor plan viewer](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/floor-viewer/components/FloorPlanContainer.tsx): `frontend/src/features/floor-viewer/components/FloorPlanContainer.tsx`
- [Room page](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/pages/RoomDetailPage.tsx): `frontend/src/pages/RoomDetailPage.tsx`
- [Room detail UI](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/room-detail/components/RoomHero.tsx): `frontend/src/features/room-detail/components/RoomHero.tsx`
- [Room loader](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/room-detail/hooks/useRoomDetail.ts): `frontend/src/features/room-detail/hooks/useRoomDetail.ts`
- [Facility page](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/pages/FacilityDetailPage.tsx): `frontend/src/pages/FacilityDetailPage.tsx`
- [Facility loader](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/features/room-detail/hooks/useFacilityDetail.ts): `frontend/src/features/room-detail/hooks/useFacilityDetail.ts`

### Frontend data

- [Campus service selector](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/services/index.ts): `frontend/src/services/index.ts`
- [Campus API adapter](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/services/campus.api.ts): `frontend/src/services/campus.api.ts`
- [HTTP client](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/services/api/apiClient.ts): `frontend/src/services/api/apiClient.ts`
- [API contracts](https://github.com/gikeeeeeee/cs361_g06/blob/main/frontend/src/shared/types/api.contracts.ts): `frontend/src/shared/types/api.contracts.ts`

### Backend API

- [Request router](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/handler.py): `backend/handler.py`
- [Building use case](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/services/building_service.py): `backend/services/building_service.py`
- [Floor use case](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/services/floor_service.py): `backend/services/floor_service.py`
- [Room use case](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/services/room_service.py): `backend/services/room_service.py`
- [Facility use case](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/services/facility_service.py): `backend/services/facility_service.py`
- [Building model](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/models/building.py): `backend/models/building.py`
- [Floor model](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/models/floor.py): `backend/models/floor.py`
- [Room model](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/models/room.py): `backend/models/room.py`
- [Facility model](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/models/facility.py): `backend/models/facility.py`

### Data access

- [Building data port](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/ports/building_source.py): `backend/ports/building_source.py`
- [S3 repository](https://github.com/gikeeeeeee/cs361_g06/blob/main/backend/repositories/building_repository.py): `backend/repositories/building_repository.py`

### Other components

- **Campus user**
- **Map service**
- **Amazon S3**

## Connections

- Campus user → Route application: opens (evidence: `frontend/src/App.tsx`)
- Route application → Home page: routes to (evidence: `frontend/src/App.tsx`)
- Route application → Building page: routes to (evidence: `frontend/src/App.tsx`)
- Route application → Room page: routes to (evidence: `frontend/src/App.tsx`)
- Route application → Facility page: routes to (evidence: `frontend/src/App.tsx`)
- Home page → Campus map UI: renders (evidence: `frontend/src/pages/HomePage.tsx`)
- Home page → Map filtering: uses (evidence: `frontend/src/pages/HomePage.tsx`)
- Map filtering → Campus service selector: queries (evidence: `frontend/src/features/homepage/hooks/useMapFilter.ts`)
- Map filtering → Directory types: uses types (evidence: `frontend/src/features/homepage/hooks/useMapFilter.ts`)
- Map service → Campus map UI: map integration (evidence: `README.md`)
- Building page → Building loader: loads data (evidence: `frontend/src/pages/BuildingDetailPage.tsx`)
- Building page → Building details UI: renders (evidence: `frontend/src/pages/BuildingDetailPage.tsx`)
- Building loader → Campus service selector: fetches building and floor (evidence: `frontend/src/features/building-info/hooks/useBuildingDetails.ts`)
- Building page → Floor plan viewer: floor plan display
- Room page → Room loader: loads data (evidence: `frontend/src/pages/RoomDetailPage.tsx`)
- Room page → Room detail UI: renders (evidence: `frontend/src/pages/RoomDetailPage.tsx`)
- Room loader → Campus service selector: fetches room (evidence: `frontend/src/features/room-detail/hooks/useRoomDetail.ts`)
- Facility page → Facility loader: loads data (evidence: `frontend/src/pages/FacilityDetailPage.tsx`)
- Facility loader → Campus service selector: fetches facility (evidence: `frontend/src/features/room-detail/hooks/useFacilityDetail.ts`)
- Campus service selector → Campus API adapter: selects adapter (evidence: `frontend/src/services/index.ts`)
- Campus API adapter → HTTP client: HTTP requests
- HTTP client → API contracts: returns typed data
- Request router → Building use case: dispatches building routes (evidence: `backend/handler.py`)
- Request router → Floor use case: dispatches floor routes (evidence: `backend/handler.py`)
- Request router → Room use case: dispatches room routes (evidence: `backend/handler.py`)
- Request router → Facility use case: dispatches facility routes (evidence: `backend/handler.py`)
- Request router → S3 repository: wires source (evidence: `backend/handler.py`)
- Building use case → Building data port: reads data (evidence: `backend/services/building_service.py`)
- Floor use case → Building data port: reads floor and plan (evidence: `backend/services/floor_service.py`)
- Floor use case → Floor model: locates floor (evidence: `backend/services/floor_service.py`)
- Floor use case → Room model: projects room pins (evidence: `backend/services/floor_service.py`)
- Floor use case → Facility model: projects facility pins (evidence: `backend/services/floor_service.py`)
- Room use case → Building data port: reads building data (evidence: `backend/services/room_service.py`)
- Room use case → Room model: finds room (evidence: `backend/services/room_service.py`)
- Facility use case → Building data port: reads data and plan URL (evidence: `backend/services/facility_service.py`)
- Facility use case → Facility model: finds facility (evidence: `backend/services/facility_service.py`)
- S3 repository → Amazon S3: reads JSON and signs URLs (evidence: `backend/repositories/building_repository.py`)
