# deepakshebani/deepak_report architecture

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

- Interactive diagram: https://gitdiagram.com/deepakshebani/deepak_report
- Repository: https://github.com/deepakshebani/deepak_report

## Overview

##### Project Type and Purpose
- This is a data-story/static-site project built with Quarto (Markdown + code), Plotly (JS/Python charts), and hosted as a static site on GitHub Pages.
- It ingests UNICEF indicators (likely CSV or API), transforms them via code chunks in .qmd files, and renders interactive HTML visualizations.

##### File Structure
- Top-level files:
– `.qmd` (Quarto source documents: unicef_report.qmd, unicef_report_with_narrative.qmd)
– Jupyter notebook (Untitled0.ipynb) – exploratory analysis
– HTML outputs (Deepak_report.html, index.html)
– Deepak_report.html is the compiled report; index.html is the landing page.
- No backend/server code—this is purely a static-site pipeline.
- Build artifacts: HTML pages, JS/CSS from Plotly and Quarto.

##### Extract Additional Insights from the README
- Live site: GitHub Pages at `deepakshebani2.github.io/Deepak_report/`.
- Four main visualization sections, each combining narrative + code.
- No mention of CI/CD, but GitHub Actions could be in use (you may surface that if configured).

##### Main Components & Interactions
a. Data Source
– UNICEF dataset files (possibly CSV or pulled via API)
b. Quarto Engine
– Reads `.qmd` sources + data
– Executes Python/R code chunks (via Jupyter or native engines)
– Emits HTML, JS, CSS assets
c. Visualization Library
– Plotly.js (rendered in the browser)
– Or Plotly in Python to pre-bake JSON
d. Static Site Assets
– HTML pages (Deepak_report.html, index.html)
– Supporting JS/CSS (Quarto theme, Plotly bundles)
e. Hosting/Delivery
– GitHub Pages CDN serving static files
– End-user browsers consuming the site

Data Source → Quarto Engine → Generated HTML/JS/CSS → GitHub Pages → Browser

##### Architectural Patterns & Principles
- Static Site Generation (SSG)
- “Code+Content” orchestration via Quarto (similar to Jekyll but code-aware)
- Client-side rendering of interactive charts (Plotly)
- Version control–based deployment (Git → GitHub Pages)

##### Detail Level
- Intermediate steps (e.g., code chunk execution, asset bundling).
- Call out key technologies next to each component (e.g., Quarto, Python, Plotly, GitHub Pages).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Data Source Layer
    Data[(UNICEF Data CSV/API)]:::dataSource

    %% Build Pipeline
    subgraph "Build Pipeline"
        direction TB
        Q1["unicef_report.qmd"]:::build
        Q2["unicef_report_with_narrative.qmd"]:::build
        NB["Untitled0.ipynb"]:::build
        README["README.md"]:::build
        QE["Quarto Engine"]:::build
        PR["Plotly Renderer"]:::build
    end

    %% Generated Site Assets
    subgraph "Generated Site Assets"
        direction TB
        REP["Deepak_report.html"]:::build
        LAND["index.html"]:::build
    end

    %% Hosting and Delivery
    HOST["GitHub Pages"]:::hosting
    GA["GitHub Actions (Optional CI)"]:::optional

    %% Client
    BROWSER["Browser Client"]:::client

    %% Connections
    Data --> NB
    Data --> Q1
    Data --> Q2
    Q1 --> QE
    Q2 --> QE
    NB --> QE
    README --> QE
    QE --> PR
    PR --> REP
    PR --> LAND
    REP --> HOST
    LAND --> HOST
    HOST --> BROWSER
    GA -.-> QE
    GA -.-> HOST

    %% Click Events
    click Q1 "https://github.com/deepakshebani/deepak_report/blob/main/unicef_report.qmd"
    click Q2 "https://github.com/deepakshebani/deepak_report/blob/main/unicef_report_with_narrative.qmd"
    click NB "https://github.com/deepakshebani/deepak_report/blob/main/Untitled0.ipynb"
    click REP "https://github.com/deepakshebani/deepak_report/blob/main/Deepak_report.html"
    click LAND "https://github.com/deepakshebani/deepak_report/blob/main/index.html"
    click README "https://github.com/deepakshebani/deepak_report/blob/main/README.md"

    %% Styles
    classDef dataSource fill:#ccffcc,stroke:#2d862d;
    classDef build fill:#cce5ff,stroke:#2d4892;
    classDef hosting fill:#ffe5cc,stroke:#924d2d;
    classDef client fill:#e0e0e0,stroke:#6d6d6d;
    classDef optional fill:#f0f0f0,stroke:#aaaaaa,dasharray:5 5;
```
