# soupiir/soupiir architecture

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

- Interactive diagram: https://gitdiagram.com/soupiir/soupiir
- Repository: https://github.com/soupiir/soupiir

## Overview

##### Project type and purpose
- This is a static‐site project built with Jekyll (Ruby), intended to organize and publish a large video gallery.
- README describes “tags” for grouping pages by category, photo, or video, indicating the site’s core feature is tag-driven organization.

##### File structure
- Top level:
- Gemfile / Gemfile.lock / _config.yml → Ruby/Jekyll configuration and dependencies
- .github/workflows/soupiir.yml → CI pipeline config (GitHub Actions)
- _data → YAML data files (videos, showcases)
- _includes / _layouts → Liquid templates and partials
- pages → markdown content for pages, categories, groups, videos
- assets → Sass, CSS, JS, raw/optimized videos
- _scripts → Python script (fetch_vimeo_showcase.py) plus its requirements.txt
- The pattern is a standard Jekyll site: content (pages + data) + templates (layouts/includes) + assets + build scripts + CI.

##### README for additional insights
- Key external integration: Vimeo API (via Python script) to fetch showcase metadata into _data.

## Diagram (Mermaid)

```mermaid
flowchart TD
    A["Source Code Repository (GitHub)"]:::repo
    B["Git Push"]:::process
    A --> B
    B --> C["GitHub Actions CI Pipeline"]:::ci
    click C "https://github.com/soupiir/soupiir/blob/main/.github/workflows/soupiir.yml"

    C --> D["Pre-build Script (fetch_vimeo_showcase.py)"]:::process
    click D "https://github.com/soupiir/soupiir/blob/main/_scripts/fetch_vimeo_showcase.py"
    click D "https://github.com/soupiir/soupiir/blob/main/_scripts/requirements.txt"
    D --> E["Vimeo API"]:::external
    E --> F["Data Layer (_data/*.yml)"]:::datastore
    click F "https://github.com/soupiir/soupiir/blob/main/_data/videos.yml"
    click F "https://github.com/soupiir/soupiir/blob/main/_data/videos_11878481.yml"

    C --> G["Jekyll Build"]:::process
    G --> H["Static Site Generator Configuration"]:::code
    click H "https://github.com/soupiir/soupiir/tree/main/Gemfile"
    click H "https://github.com/soupiir/soupiir/blob/main/Gemfile.lock"
    click H "https://github.com/soupiir/soupiir/blob/main/_config.yml"

    G --> I["Liquid Templates & Layouts"]:::template
    click I "https://github.com/soupiir/soupiir/blob/main/_includes/about.html"
    click I "https://github.com/soupiir/soupiir/blob/main/_includes/block-mosaic.html"
    click I "https://github.com/soupiir/soupiir/blob/main/_includes/bottom-scripts.html"
    click I "https://github.com/soupiir/soupiir/blob/main/_includes/contact.html"
    click I "https://github.com/soupiir/soupiir/blob/main/_includes/headers.html"
    click I "https://github.com/soupiir/soupiir/blob/main/_includes/homepage.html"
    click I "https://github.com/soupiir/soupiir/blob/main/_includes/nav.html"
    click I "https://github.com/soupiir/soupiir/blob/main/_includes/top-scripts.html"
    click I "https://github.com/soupiir/soupiir/blob/main/_layouts/default.md"
    click I "https://github.com/soupiir/soupiir/blob/main/_layouts/category.md"
    click I "https://github.com/soupiir/soupiir/blob/main/_layouts/group.md"
    click I "https://github.com/soupiir/soupiir/blob/main/_layouts/showcase.md"
    click I "https://github.com/soupiir/soupiir/blob/main/_layouts/video.md"

    G --> J["Content Pages"]:::content
    click J "https://github.com/soupiir/soupiir/blob/main/pages/index.md"
    click J "https://github.com/soupiir/soupiir/blob/main/pages/about.md"
    click J "https://github.com/soupiir/soupiir/blob/main/pages/contact.md"
    click J "https://github.com/soupiir/soupiir/blob/main/pages/404.md"
    click J "https://github.com/soupiir/soupiir/blob/main/pages/robots.txt"
    click J "https://github.com/soupiir/soupiir/blob/main/pages/site.webmanifest"
    click J "https://github.com/soupiir/soupiir/blob/main/pages/sitemap.xml"
    click J "https://github.com/soupiir/soupiir/tree/main/pages/categories/"
    click J "https://github.com/soupiir/soupiir/tree/main/pages/groups/"
    click J "https://github.com/soupiir/soupiir/tree/main/pages/showcases/"
    click J "https://github.com/soupiir/soupiir/tree/main/pages/videos/"

    C --> K["Asset Pipeline"]:::asset
    click K "https://github.com/soupiir/soupiir/tree/main/assets/_sass/"
    click K "https://github.com/soupiir/soupiir/blob/main/assets/css/style.scss"
    click K "https://github.com/soupiir/soupiir/blob/main/assets/js/lightbox.js"
    click K "https://github.com/soupiir/soupiir/tree/main/assets/favicons/"

    K --> L["Raw & Optimized Video Storage"]:::asset
    click L "https://github.com/soupiir/soupiir/tree/main/assets/videos/"
    click L "https://github.com/soupiir/soupiir/tree/main/assets/videos/optimized/"

    G --> M["Generated Static Site"]:::output
    M --> N["Hosting (GitHub Pages)"]:::hosting
    click N "https://github.com/soupiir/soupiir/tree/main/CNAME"
    click N "https://github.com/soupiir/soupiir/blob/main/README.md"

    classDef repo fill:#D6EAF8,stroke:#5DADE2,color:#1B4F72;
    classDef ci fill:#F5EEF8,stroke:#AF7AC5,color:#6C3483;
    classDef process fill:#FCF3CF,stroke:#F4D03F,color:#7D6608;
    classDef external fill:#FDEDEC,stroke:#EC7063,color:#641E16;
    classDef datastore fill:#E8F8F5,stroke:#48C9B0,color:#0E6251;
    classDef code fill:#EBF5FB,stroke:#5DADE2,color:#1B4F72;
    classDef template fill:#FEF9E7,stroke:#F39C12,color:#7E5109;
    classDef content fill:#EAECEE,stroke:#BDC3C7,color:#566573;
    classDef asset fill:#F2F3F4,stroke:#A6ACAF,color:#424949;
    classDef output fill:#EBF5FB,stroke:#5499C7,color:#1B4F72;
    classDef hosting fill:#FDF2E9,stroke:#DC7633,color:#78281F;
```
