# langaracpsc/langaracourseplanner architecture

> Architecture diagram of the GitHub repository langaracpsc/langaracourseplanner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/langaracpsc/langaracourseplanner
- Repository: https://github.com/langaracpsc/langaracourseplanner

## Overview

##### Main Components

a) Frontend Layer:
- Static Content
- HTML pages (templates directory)
- JavaScript modules (static/js directory)
- CSS styles (static/styles.css)
- Third-party libraries (static/libraries)
- Client-side Features
- Calendar functionality (Calendar.js)
- Course management (Course.js)
- Client-side database (Database.js)
- Save functionality (SaveManager.js)

b) Backend Layer:
- Flask Web Server (main.py)
- Route handlers for:
- Dynamic course pages
- Static content serving

c) Data Layer:
- SQL.js (client-side database)
- Course data storage

**[Client Browser]**
- ↕
**[Frontend Layer]**
- ↕
**[Backend Layer]**

##### Component Relationships

- HTTP requests between client and server
- Data flow between frontend JavaScript modules
- Database interactions
- Static asset serving paths

##### Detailed Component Breakdown

Frontend:
**[Static Assets] → [HTML Templates]**
- ↓
**[JavaScript Modules]**
- Calendar.js
- Course.js
- Database.js
- SaveManager.js
- ↓
**[Third-party Libraries]**
- FullCalendar
- Fuse.js
- SQL.js

Backend:
**[Flask Server]**
- Course routes
- Static file serving

##### Implementation Details

- How the client-side database interacts with the UI
- Course planning workflow
- Demonstrate how the calendar integration works
- Static vs. dynamic content handling

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        Browser["Web Browser"]
    end

    subgraph "Frontend Layer"
        direction TB
        StaticContent["Static Content"]
        Templates["HTML Templates"]:::templates
        Styles["CSS Styles"]:::styles
        
        subgraph "JavaScript Core"
            direction TB
            Calendar["Calendar Module"]:::calendar
            Course["Course Management"]:::course
            Database["Client Database"]:::database
            SaveManager["Save Manager"]:::savemanager
            MainLogic["Main Logic"]:::mainlogic
            Planner["Planner Interface"]:::planner
            CalHelpers["Calendar Helpers"]:::calhelpers
        end

        subgraph "Third-party Libraries"
            direction TB
            FullCalendar["FullCalendar"]:::fullcalendar
            SQLjs["SQL.js"]:::sqljs
            Fusejs["Fuse.js"]:::fusejs
        end

        CourseTemplate["Course Template"]:::coursetemplate
        PlannerTemplate["Planner Template"]:::plannertemplate
    end

    subgraph "Backend Layer"
        Flask["Flask Server"]:::flask
    end

    %% Relationships
    Browser --> Flask
    Flask --> StaticContent
    StaticContent --> Templates
    StaticContent --> Styles
    
    Calendar --> FullCalendar
    Database --> SQLjs
    Course --> Fusejs
    
    Calendar --> CalHelpers
    MainLogic --> Calendar
    MainLogic --> Course
    MainLogic --> Database
    MainLogic --> SaveManager
    Planner --> MainLogic
    
    Templates --> CourseTemplate
    Templates --> PlannerTemplate

    %% Styles
    classDef flask fill:#f9f,stroke:#333
    classDef templates fill:#ddf,stroke:#333
    classDef styles fill:#dfd,stroke:#333
    classDef calendar fill:#fdd,stroke:#333
    classDef course fill:#dfd,stroke:#333
    classDef database fill:#ffd,stroke:#333
    classDef savemanager fill:#ddf,stroke:#333
    classDef mainlogic fill:#dff,stroke:#333
    classDef planner fill:#fdf,stroke:#333
    classDef calhelpers fill:#fdd,stroke:#333
    classDef fullcalendar fill:#ddd,stroke:#333
    classDef sqljs fill:#ddd,stroke:#333
    classDef fusejs fill:#ddd,stroke:#333
    classDef coursetemplate fill:#ddf,stroke:#333
    classDef plannertemplate fill:#ddf,stroke:#333

    %% Click Events
    click Flask "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/main.py"
    click Templates "https://github.com/langaracpsc/LangaraCoursePlanner/tree/main/templates/"
    click Styles "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/styles.css"
    click Calendar "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/js/Calendar.js"
    click Course "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/js/Course.js"
    click Database "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/js/Database.js"
    click SaveManager "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/js/SaveManager.js"
    click FullCalendar "https://github.com/langaracpsc/LangaraCoursePlanner/tree/main/static/libraries/fullcalendar/"
    click SQLjs "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/libraries/sql/sql.js"
    click Fusejs "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/libraries/fuse/fuse.js"
    click MainLogic "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/main.js"
    click Planner "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/planner.js"
    click CourseTemplate "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/templates/course.html"
    click PlannerTemplate "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/templates/planner.html"
    click CalHelpers "https://github.com/langaracpsc/LangaraCoursePlanner/blob/main/static/js/FCalendarHelpers.js"
```
