# ab9mamun/emil-website architecture

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

- Interactive diagram: https://gitdiagram.com/ab9mamun/emil-website
- Repository: https://github.com/ab9mamun/emil-website

## Overview

##### Main Components
a. Content Layer
- “content/”, “data/”, “static/”: Markdown, TOML, media, front‑matter templates.
- Forestry CMS (optional) for editing front matter (shown as an external CMS service).
b. Presentation Layer
- Hugo engine + Academic theme (“layouts/”, “assets/”, “config.toml”, “go.mod”).
- Custom SCSS/JS under “assets/” and “layouts/partials/”.
c. Build & CI/CD
- Git repository (GitHub/GitLab).
- Netlify Build (hooks into repo, runs `hugo`, runs scripts like `utils/parse_talks.py`, `update_academic.sh`).
d. Hosting & Delivery
- Netlify CDN serving the generated static HTML, CSS, JS.
- Optional viewer tooling (`view.sh`, local `hugo server`) for previews.

##### Relationships & Data Flow
- Developer edits content or code → commits to Git.
- Netlify notices push → runs the build pipeline:
- Clones repo → installs dependencies (`go.mod` & Hugo modules) → runs pre‑build scripts → `hugo` generates `public/` folder.
- Deploys `public/` to Netlify CDN.
- End‑user browser fetches assets from Netlify CDN.
- Forestry CMS (if enabled) updates content via Git commits.

##### Architectural Patterns & Principles
- Static Site Generation (SSG): separation of content, templates, and build.
- Theming & Extendability: Academic theme modules plus local overrides in “layouts/”.
- CI/CD pipeline: automated, Git‑driven continuous deployment.
- Modular configuration: top‑level `config.toml` plus environment overrides in `config/_default/`.
- Asset Pipeline: SCSS compilation, JS bundling via Hugo Pipes.

##### Technologies, Frameworks & Tools
- Hugo (Go-based SSG)
- Academic (Hugo) theme
- SCSS (via Hugo Pipes)
- Netlify (CI/CD, hosting, CDN)
- Git (version control)
- Forestry CMS (Git-based content editor)
- Python scripts for content preprocessing (`utils/parse_talks.py`)
- Shell scripts for init/setup (`scripts/init_kickstart.sh`)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Content Management Layer
    subgraph "Content Management" 
        direction TB
        Dev["Developer"]:::external
        Git["Git Repository"]:::source
        C_content["content/"]:::source
        C_data["data/"]:::source
        C_static_src["static/"]:::source
        CMS["Forestry CMS"]:::external
    end

    Dev -->|"push changes"| Git
    CMS -->|"commits via Git"| Git
    Git --> C_content
    Git --> C_data
    Git --> C_static_src

    click C_content "https://github.com/ab9mamun/emil-website/tree/main/content/"
    click C_data "https://github.com/ab9mamun/emil-website/tree/main/data/"
    click C_static_src "https://github.com/ab9mamun/emil-website/tree/main/static/"
    click CMS "https://github.com/ab9mamun/emil-website/tree/main/.forestry/"

    %% Build System Layer
    subgraph "Build System" 
        direction TB
        NetlifyBuild["Netlify Build"]:::build
        subgraph "Source & Config"
            direction TB
            L_layouts["layouts/"]:::source
            L_partials["layouts/partials/"]:::source
            A_assets["assets/"]:::source
            A_scss["assets/scss/custom.scss"]:::source
            A_jscfg["assets/jsconfig.json"]:::source
            CFG_root["config.toml"]:::source
            CFG_defaults["config/_default/"]:::source
            Gomod["go.mod & go.sum"]:::source
        end
        subgraph "Pre/Post Build Scripts"
            direction TB
            S_init["scripts/init_kickstart.sh"]:::build
            S_update["update_academic.sh"]:::build
            U_parse["utils/parse_talks.py"]:::build
            U_talks["utils/talks.txt"]:::build
            S_view["view.sh"]:::build
        end
        Hugo["Hugo Engine"]:::build
        Public["public/"]:::build
    end

    Git -->|"trigger build hook"| NetlifyBuild
    NetlifyBuild -->|"clone repo & install modules"| L_layouts
    NetlifyBuild --> A_assets
    NetlifyBuild --> CFG_root
    NetlifyBuild --> CFG_defaults
    NetlifyBuild --> Gomod
    NetlifyBuild --> S_init
    NetlifyBuild --> S_update
    NetlifyBuild --> U_parse
    NetlifyBuild --> S_view
    NetlifyBuild --> Hugo
    Hugo -->|"generate site"| Public

    click L_layouts "https://github.com/ab9mamun/emil-website/tree/main/layouts/"
    click L_partials "https://github.com/ab9mamun/emil-website/tree/main/layouts/partials/"
    click A_assets "https://github.com/ab9mamun/emil-website/tree/main/assets/"
    click A_scss "https://github.com/ab9mamun/emil-website/blob/main/assets/scss/custom.scss"
    click A_jscfg "https://github.com/ab9mamun/emil-website/blob/main/assets/jsconfig.json"
    click CFG_root "https://github.com/ab9mamun/emil-website/blob/main/config.toml"
    click CFG_defaults "https://github.com/ab9mamun/emil-website/tree/main/config/_default/"
    click Gomod "https://github.com/ab9mamun/emil-website/blob/main/go.mod"
    click S_init "https://github.com/ab9mamun/emil-website/blob/main/scripts/init_kickstart.sh"
    click S_update "https://github.com/ab9mamun/emil-website/blob/main/update_academic.sh"
    click U_parse "https://github.com/ab9mamun/emil-website/blob/main/utils/parse_talks.py"
    click U_talks "https://github.com/ab9mamun/emil-website/blob/main/utils/talks.txt"
    click S_view "https://github.com/ab9mamun/emil-website/blob/main/view.sh"

    %% Hosting & Delivery Layer
    subgraph "Hosting & Delivery"
        direction TB
        CDN["Netlify CDN"]:::hosting
        User["End User Browser"]:::external
    end

    Public -->|"deploy output"| CDN
    C_static_src -->|"static assets served"| CDN
    CDN -->|"serve assets"| User

    click Public "https://github.com/ab9mamun/emil-website/tree/main/public/"

    %% Styles
    classDef source fill:#bbdefb,stroke:#1e88e5,color:#000
    classDef build fill:#ffe0b2,stroke:#fb8c00,color:#000
    classDef hosting fill:#c8e6c9,stroke:#43a047,color:#000
    classDef external fill:#e0e0e0,stroke:#757575,color:#000
```
