# jannikmenzel/ifsr-website architecture

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

- Interactive diagram: https://gitdiagram.com/jannikmenzel/ifsr-website
- Repository: https://github.com/jannikmenzel/ifsr-website

## Overview

##### Project Type and Purpose
- This is a **static website** generated with the **Hugo** SSG framework.
- It serves as the official information portal for TU Dresden’s iFSR, using Markdown content, templates, and assets to produce a fully static site.

##### Main Components
a. **Content Layer**
- `content/` (Markdown pages)
- `data/navigation.toml` (menu structure)
- `archetypes/` (front‐matter templates)
b. **Presentation Layer**
- `layouts/` (Hugo templates: base, section, single, partials, shortcodes)
c. **Build Engine**
- **Hugo** CLI / Server
- `hugo.toml` (site config)
- GitHub Actions (`.github/workflows/hugo.yaml`) for CI/CD
d. **Hosting & Delivery**
- Static host (e.g., Netlify, GitHub Pages) serving the generated `public/` output
- Browser clients requesting HTML/CSS/JS

##### Relationships & Data Flow
1. **Developer Workflow**
- Developer pushes content/layout changes → GitHub repo
- CI Workflow triggers Hugo build
2. **Build Process**
- Hugo reads `content/`, `data/`, `archetypes/`
- Hugo applies `layouts/` and processes `assets/`
- Generates final static files in `public/`
3. **Deployment**
- CI pushes `public/` to hosting provider
- Hosting serves assets to end users’ browsers
4. **Runtime**
- Browser requests HTML/JS/CSS
- Assets loaded from CDN or static host

##### Architectural Patterns & Design Principles
- **Static Site Generation**: pre-rendering all content at build time
- **Separation of Concerns**:
- Content vs. Layout/Template vs. Assets vs. Data
- **Template Inheritance**: base templates + partials + shortcodes
- **Continuous Deployment**: Git → CI → Hugo → Hosting

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Source"
        Developer["Developer"]:::user
        Repo["GitHub Repo"]:::code
        Gitignore[".gitignore"]:::code
        Readme["README.md"]:::code
        Developer -->|"push changes"| Repo
        Repo -->|"includes"| Gitignore
        Repo -->|"includes"| Readme
    end

    subgraph "Build"
        CI["GitHub Actions CI"]:::build
        Workflow[".github/workflows/hugo.yaml"]:::build
        HugoCLI["Hugo CLI"]:::build
        HugoConf["hugo.toml"]:::code
        Repo -->|"trigger CI"| CI
        CI -->|"uses config"| Workflow
        CI -->|"runs hugo"| HugoCLI
        HugoCLI -->|"reads config"| HugoConf
        subgraph "Hugo Input"
            Md["content/ (Markdown)"]:::code
            Nav["data/navigation.toml"]:::code
            Arch["archetypes/default.md"]:::code
            Base["layouts/_default/baseof.html"]:::code
            Section["layouts/_default/section.html"]:::code
            Single["layouts/_default/single.html"]:::code
            Home["layouts/_default/home.html"]:::code
            NotFound["layouts/404.html"]:::code
            Partials["layouts/_partials/"]:::code
            Shortcodes["layouts/shortcodes/"]:::code
            CSSmain["assets/css/main.css"]:::code
            CSSmd["assets/css/markdown.css"]:::code
            CSSsc["assets/css/shortcodes.css"]:::code
            JSmain["assets/js/main.js"]:::code
            AssetsIcons["assets/icons/"]:::code
            AssetsImages["assets/images/"]:::code
            AdminConf["static/admin/config.yml"]:::code
            AdminIndex["static/admin/index.html"]:::code
            PDFs["static/other/*.pdf"]:::code
            StaticIcons["static/icons/"]:::code
            StaticImages["static/images/"]:::code
            Md & Nav & Arch & Base & Section & Single & Home & NotFound & Partials & Shortcodes & CSSmain & CSSmd & CSSsc & JSmain & AssetsIcons & AssetsImages & AdminConf & AdminIndex & PDFs & StaticIcons & StaticImages --> HugoCLI
        end
        HugoCLI -->|"generate static site"| Public["public/"]:::code
    end

    subgraph "Delivery"
        Hosting["Hosting Platform (Netlify/GitHub Pages)"]:::infra
        Browser["Browser Client"]:::user
        Public -->|"deploy"| Hosting
        Hosting -->|"serve assets"| Browser
        Browser -->|"request HTML/CSS/JS"| Hosting
    end

    click Md "https://github.com/jannikmenzel/ifsr-website/tree/main/content/"
    click Nav "https://github.com/jannikmenzel/ifsr-website/blob/main/data/navigation.toml"
    click Arch "https://github.com/jannikmenzel/ifsr-website/blob/main/archetypes/default.md"
    click Base "https://github.com/jannikmenzel/ifsr-website/blob/main/layouts/_default/baseof.html"
    click Section "https://github.com/jannikmenzel/ifsr-website/blob/main/layouts/_default/section.html"
    click Single "https://github.com/jannikmenzel/ifsr-website/blob/main/layouts/_default/single.html"
    click Home "https://github.com/jannikmenzel/ifsr-website/blob/main/layouts/_default/home.html"
    click NotFound "https://github.com/jannikmenzel/ifsr-website/blob/main/layouts/404.html"
    click Partials "https://github.com/jannikmenzel/ifsr-website/tree/main/layouts/_partials/"
    click Shortcodes "https://github.com/jannikmenzel/ifsr-website/tree/main/layouts/shortcodes/"
    click CSSmain "https://github.com/jannikmenzel/ifsr-website/blob/main/assets/css/main.css"
    click CSSmd "https://github.com/jannikmenzel/ifsr-website/blob/main/assets/css/markdown.css"
    click CSSsc "https://github.com/jannikmenzel/ifsr-website/blob/main/assets/css/shortcodes.css"
    click JSmain "https://github.com/jannikmenzel/ifsr-website/blob/main/assets/js/main.js"
    click AssetsIcons "https://github.com/jannikmenzel/ifsr-website/tree/main/assets/icons/"
    click AssetsImages "https://github.com/jannikmenzel/ifsr-website/tree/main/assets/images/"
    click AdminConf "https://github.com/jannikmenzel/ifsr-website/blob/main/static/admin/config.yml"
    click AdminIndex "https://github.com/jannikmenzel/ifsr-website/blob/main/static/admin/index.html"
    click PDFs "https://github.com/jannikmenzel/ifsr-website/blob/main/static/other/*.pdf"
    click StaticIcons "https://github.com/jannikmenzel/ifsr-website/tree/main/static/icons/"
    click StaticImages "https://github.com/jannikmenzel/ifsr-website/tree/main/static/images/"
    click HugoConf "https://github.com/jannikmenzel/ifsr-website/blob/main/hugo.toml"
    click Workflow "https://github.com/jannikmenzel/ifsr-website/blob/main/.github/workflows/hugo.yaml"
    click Gitignore "https://github.com/jannikmenzel/ifsr-website/blob/main/.gitignore"
    click Readme "https://github.com/jannikmenzel/ifsr-website/blob/main/README.md"

    classDef code fill:#D0E8FF,stroke:#000;
    classDef build fill:#DFFFE0,stroke:#000;
    classDef infra fill:#F0F0F0,stroke:#000;
    classDef user fill:#FFF5D0,stroke:#000;
```
