# fahimgbon/campusinsights architecture

> Architecture diagram of the GitHub repository fahimgbon/campusinsights, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fahimgbon/campusinsights
- Repository: https://github.com/fahimgbon/campusinsights

## Overview

##### Project type and purpose
- This is a full-stack web application (“Sections Insight”) for UBC course section management and insight.
- The frontend is a React/TypeScript SPA; the backend is a Node/TypeScript REST API layer that ingests zipped datasets, validates and processes queries, and serves results.

##### File structure
- Top level:
- frontend/ – React application (public/, src/, package.json, etc.)
- src/ – backend code:
– rest/Server.ts: Express HTTP server entrypoint
– controller/: InsightFacade, Dataset, Room, Section controllers & processors
– performQuery/: QueryValidator and ApplyQuery engine
- test/: unit/integration tests for both controller logic and REST endpoints
- Config files: tsconfig.json, ESLint, Prettier, .gitignore, etc.
- No external database driver – in-memory dataset management via InsightFacade.

##### README
- Describes only the frontend startup but file-tree confirms full-stack.
- Mentions “working with an API and translating it into a user interface,” implying a clear client↔server separation.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    subgraph "Client Layer"
        ReactUI["React UI (Browser/React SPA)"]:::frontend
        ReactEntry["App.js Entry Point"]:::frontend
        AddDS["Add Dataset Component"]:::frontend
        RemoveDS["Remove Dataset Component"]:::frontend
        ListDS["List Datasets Component"]:::frontend
        Insights["Dataset Insights Component"]:::frontend
        Display["Dataset Display Component"]:::frontend
    end

    %% Server Layer
    subgraph "Server Layer"
        ExpressAPI["Express REST API (Server.ts)"]:::api

        subgraph "Controllers"
            Facade["InsightFacade Controller"]:::logic
            DatasetCtrl["Dataset Controller"]:::logic
            SectionCtrl["Section Controller"]:::logic
            RoomCtrl["Room Controller"]:::logic
        end

        subgraph "Processors"
            KindProc["KindProcessor"]:::logic
            SectionProc["SectionProcessor"]:::logic
            RoomProc["RoomProcessor"]:::logic
        end

        subgraph "Query Engine"
            Validator["QueryValidator"]:::logic
            Executor["ApplyQuery"]:::logic
        end

        subgraph "Data & FS"
            DataStore["In-Memory Data Store"]:::fs
            FileSys["File System (Unzip)"]:::fs
        end
    end

    %% Test Harness
    subgraph "Test Harness / CI"
        TestCtrl["Controller Unit Tests"]:::test
        TestREST["REST Endpoint Tests"]:::test
    end

    %% Connections
    ReactUI -->|"HTTP: POST/DELETE /dataset, POST /query"| ExpressAPI
    ExpressAPI -->|"calls addDataset/removeDataset/performQuery"| Facade
    Facade -->|"add/remove datasets"| DatasetCtrl
    Facade -->|"query datasets"| Validator
    Validator -->|"validates query"| Executor
    Executor -->|"executes query pipeline"| Facade
    Facade -->|"uses processors"| KindProc
    KindProc -->|"delegates to"| RoomProc
    KindProc -->|"delegates to"| SectionProc
    KindProc -->|"reads/writes"| FileSys
    Facade -->|"stores data in"| DataStore
    Facade -->|"reads data from"| DataStore
    ExpressAPI -->|"responds with data"| ReactUI

    TestCtrl -->|"invokes methods on"| Facade
    TestREST -->|"hits endpoints on"| ExpressAPI

    %% Click Events
    click ReactUI "https://github.com/fahimgbon/campusinsights/tree/main/frontend/src/"
    click ReactEntry "https://github.com/fahimgbon/campusinsights/blob/main/frontend/src/App.js"
    click AddDS "https://github.com/fahimgbon/campusinsights/blob/main/frontend/src/Components/AddDataset.tsx"
    click RemoveDS "https://github.com/fahimgbon/campusinsights/blob/main/frontend/src/Components/RemoveDataset.tsx"
    click ListDS "https://github.com/fahimgbon/campusinsights/blob/main/frontend/src/Components/List Datasets.tsx"
    click Insights "https://github.com/fahimgbon/campusinsights/blob/main/frontend/src/Components/DatasetInsights.tsx"
    click Display "https://github.com/fahimgbon/campusinsights/blob/main/frontend/src/Components/Dataset.tsx"
    click ExpressAPI "https://github.com/fahimgbon/campusinsights/blob/main/src/rest/Server.ts"
    click Facade "https://github.com/fahimgbon/campusinsights/blob/main/src/controller/InsightFacade.ts"
    click DatasetCtrl "https://github.com/fahimgbon/campusinsights/blob/main/src/controller/Dataset.ts"
    click SectionCtrl "https://github.com/fahimgbon/campusinsights/blob/main/src/controller/Section.ts"
    click RoomCtrl "https://github.com/fahimgbon/campusinsights/blob/main/src/controller/Room.ts"
    click KindProc "https://github.com/fahimgbon/campusinsights/blob/main/src/controller/KindProcessor.ts"
    click SectionProc "https://github.com/fahimgbon/campusinsights/blob/main/src/controller/SectionProcessor.ts"
    click RoomProc "https://github.com/fahimgbon/campusinsights/blob/main/src/controller/RoomProcessor.ts"
    click Validator "https://github.com/fahimgbon/campusinsights/blob/main/src/performQuery/QueryValidator.ts"
    click Executor "https://github.com/fahimgbon/campusinsights/blob/main/src/performQuery/ApplyQuery.ts"
    click TestCtrl "https://github.com/fahimgbon/campusinsights/blob/main/test/controller/InsightFacade.spec.ts"
    click TestREST "https://github.com/fahimgbon/campusinsights/blob/main/test/rest/Server.spec.ts"

    %% Styles
    classDef frontend fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef api fill:#90EE90,stroke:#000,stroke-width:1px
    classDef logic fill:#FFD580,stroke:#000,stroke-width:1px
    classDef fs fill:#D3D3D3,stroke:#000,stroke-width:1px
    classDef test fill:#DDA0DD,stroke:#000,stroke-width:1px
```
