# yamanalrifaii/air-quality-monitoring-system architecture

> Architecture diagram of the GitHub repository yamanalrifaii/air-quality-monitoring-system, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yamanalrifaii/air-quality-monitoring-system
- Repository: https://github.com/yamanalrifaii/air-quality-monitoring-system

## Overview

##### Project type and purpose
- This is a static, multi‑page front‑end web application (“Air‑Quality‑Monitoring‑System”) deployed on a static‐hosting service (e.g. GitHub Pages).
- Purpose: provide real‑time Air Quality Index (AQI) data on a map, compare AQI across cities, and calculate Carbon Footprint (CFP).

##### File structure
- Top level: a README plus a set of HTML/CSS/JS triads, one per feature:
- index.html/.css/.js – landing/home page
- login.html/.css/.js – authentication UI
- .html/.css/.js – interactive map showing AQI
- compare.html/.css/.js – side‑by‑side city comparison
- cfp.html/.css/.js – carbon footprint calculator
- A shared main.css for global styling.
- No backend code or server‑side components—entirely client‑side.

##### Key insights from the README
- Deployed as a web dashboard for authorities and general users.
- Relies on “real‑time” AQI data—implies external third‑party APIs (e.g., World Air Quality Index project, OpenWeather, or similar).
- Offers mapping (likely using a tile API or a JS mapping library like Leaflet).
- CFP calculations are done client‑side via embedded JavaScript.

##### Components
a. Client (Browser)
- UI Pages:
- Home (index.html)
- Login (login.html)
- View (map.html + map.js + map.css)
- Comparison view (compare.html + compare.js + compare.css)
- CFP calculator (cfp.html + cfp.js + cfp.css)
- Shared assets: main.css
- JavaScript modules for API calls, UI logic, data parsing
b. Static Hosting Layer
- GitHub Pages / CDN hosting all HTML/CSS/JS assets
c. External Services
- AQI Data API (REST endpoints providing air quality metrics)
- Tile Service (e.g., OpenStreetMap, Mapbox tiles)
- (Optional) Authentication Provider (OAuth or custom auth API)
d. Data Flows & Interactions
- Browser → Static Hosting: fetch HTML/CSS/JS
- Browser → AQI API: GET requests for current AQI, pollutant concentration
- Browser → Map Tile Service: GET tile images or vector tiles
- Browser (login page) → Auth API: authenticate user (if implemented)
- Browser (CFP page) → local JS module: client‑side CFP calculation

##### Architectural patterns & design principles
- Static web‑tier pattern: purely client‑side, no dedicated backend server
- Multi‑page application (MPA) with per‑feature JS modules—each page loads only the code it needs
- Separation of concerns:
- Presentation: HTML + CSS
- Behavior: Feature‑specific JS
- Styling: page‑specific CSS + main.css for global styles

##### Putting it all together—what to capture
- Clear labels: page names, service names, hosting platform
- Boundaries: group all static assets under “Static Hosting.” Group each page’s code under the “Browser.”
- Data flows: show where real‑time data comes from, where map tiles come from, and where calculations occur
- Callouts: note which JS file in each page handles which API or feature (e.g., map.js → loads tiles + AQI data; cfp.js → local CFP logic)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Browser with client pages
    subgraph "Browser (Client)" 
        direction TB
        HomeHTML["index.html"]:::client
        LoginHTML["login.html"]:::client
        MapHTML["map.html"]:::client
        CompareHTML["compare.html"]:::client
        CFPHTML["cfp.html"]:::client
        MainCSS["main.css"]:::client
        LoginJS["login.js"]:::client
        LoginCSS["login.css"]:::client
        MapJS["map.js"]:::client
        MapCSS["map.css"]:::client
        CompareJS["compare.js"]:::client
        CompareCSS["compare.css"]:::client
        CFPJS["cfp.js"]:::client
        CFPCSS["cfp.css"]:::client
    end

    %% Static hosting layer
    StaticHost["Static Hosting (GitHub Pages/CDN)"]:::hosting

    %% External services
    AQIAPI["AQI Data API"]:::external
    MapTiles["Map Tile Service"]:::external
    AuthAPI["Authentication API"]:::external

    %% Asset delivery
    StaticHost -->|"GET HTML/CSS/JS"| HomeHTML
    StaticHost -->|"GET HTML/CSS/JS"| LoginHTML
    StaticHost -->|"GET HTML/CSS/JS"| MapHTML
    StaticHost -->|"GET HTML/CSS/JS"| CompareHTML
    StaticHost -->|"GET HTML/CSS/JS"| CFPHTML
    StaticHost -->|"GET main.css"| MainCSS

    %% Authentication flow
    LoginHTML -->|"loads login.js"| LoginJS
    LoginHTML -->|"loads login.css"| LoginCSS
    LoginJS -->|"POST credentials (JSON)"| AuthAPI
    AuthAPI -->|"200 OK"| LoginJS

    %% Map view interactions
    MapHTML -->|"loads map.js"| MapJS
    MapHTML -->|"loads map.css"| MapCSS
    MapJS -->|"GET tiles (image)"| MapTiles
    MapJS -->|"GET AQI data (JSON)"| AQIAPI

    %% Comparison view interactions
    CompareHTML -->|"loads compare.js"| CompareJS
    CompareHTML -->|"loads compare.css"| CompareCSS
    CompareJS -->|"GET AQI data (JSON)"| AQIAPI

    %% CFP calculator interactions
    CFPHTML -->|"loads cfp.js"| CFPJS
    CFPHTML -->|"loads cfp.css"| CFPCSS
    CFPJS -->|"Client-side calculation"| CFPJS

    %% Shared CSS loaded by pages
    HomeHTML -->|"loads main.css"| MainCSS
    LoginHTML -->|"loads main.css"| MainCSS
    MapHTML -->|"loads main.css"| MainCSS
    CompareHTML -->|"loads main.css"| MainCSS
    CFPHTML -->|"loads main.css"| MainCSS

    %% Click Events for component mapping
    click HomeHTML "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/index.html"
    click MainCSS "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/main.css"
    click LoginHTML "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/login.html"
    click LoginCSS "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/login.css"
    click LoginJS "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/login.js"
    click MapHTML "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/map.html"
    click MapCSS "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/map.css"
    click MapJS "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/map.js"
    click CompareHTML "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/compare.html"
    click CompareCSS "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/compare.css"
    click CompareJS "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/compare.js"
    click CFPHTML "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/cfp.html"
    click CFPCSS "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/cfp.css"
    click CFPJS "https://github.com/yamanalrifaii/air-quality-monitoring-system/blob/main/cfp.js"

    %% Styles
    classDef client fill:#d0e7ff,stroke:#000,stroke-width:1px
    classDef hosting fill:#d4f5d4,stroke:#000,stroke-width:1px
    classDef external fill:#ffe5b4,stroke:#000,stroke-width:1px
```
