# jenswittmann/curlyframework architecture

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

- Interactive diagram: https://gitdiagram.com/jenswittmann/curlyframework
- Repository: https://github.com/jenswittmann/curlyframework

## Overview

##### Project type and purpose
- CurlyFramework is a front-end UI framework/library (CSS + JS) meant to be installed via npm or git, and then integrated into static sites or CMS templates (e.g., MODX, Kirby). It provides SCSS modules, JS utilities, and a build pipeline to produce a ready-to-ship CSS/JS bundle, plus a styleguide/demo site.

##### File structure
- Top-level files & folders:
- dev/ – source SCSS partials (_*.scss) and raw JS, plus a JS bundle template
- demo/ – sample JSON data for demonstration
- styleguide/ – compiled CSS, JS, and HTML pages illustrating framework usage
- index.html – entry point demo
- package.json, build/config files (.editorconfig, .prettierrc, CodeKit)
- No server-side code; this is a build-and-publish pipeline producing static assets.

##### README for additional insights
- Confirms it’s a “personal framework for more accessibility and sustainability.”
- Installation via npm and a hosted documentation/demo URL.

##### Elements
- From source folders (dev/css, dev/js) into build steps
- From build steps into outputs (styleguide/, npm package)
- From npm package into Consumer Integration
- e.g., blue for source code, green for build tools, orange for distribution artefacts, purple for consumer/demo

##### Detailed capture of essential architectural elements
- Folder boundaries (dev vs. styleguide vs. demo)
- Configuration files (.editorconfig, .prettierrc, package.json) feeding into the build toolchain

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Developer Workstation"
        DevWS["Developer Workstation"]:::source
        DevCSS["dev/css/"]:::source
        DevJS["dev/js/"]:::source
        DevWS --> DevCSS
        DevWS --> DevJS
    end

    subgraph "Build Toolchain"
        Sass["SCSS Compiler"]:::buildTool
        JSB["JS Bundler"]:::buildTool
        CodeKit[".config.codekit3"]:::config
        EditorCfg[".editorconfig"]:::config
        PrettierRC[".prettierrc"]:::config
        Dependabot[".github/dependabot.yml"]:::config
        PrettierIgnore[".prettierignore"]:::config

        DevCSS --> Sass
        DevJS --> JSB
        CodeKit -.-> Sass
        EditorCfg -.-> Sass
        PrettierRC -.-> Sass
        Dependabot -.-> Sass
        PrettierIgnore -.-> Sass
        CodeKit -.-> JSB
        EditorCfg -.-> JSB
        PrettierRC -.-> JSB
        Dependabot -.-> JSB
        PrettierIgnore -.-> JSB
    end

    Sass --> StyleCSS["styleguide/css/style.css"]:::dist
    JSB --> ScriptJS["styleguide/js/script.js"]:::dist

    subgraph "Distribution Package"
        Package["npm Package"]:::dist
        Workflow["CI/CD Workflow"]:::config

        StyleCSS --> Package
        ScriptJS --> Package
        Workflow --> Package
        Package -->|"publish"| ConsumerSite["Consumer Site"]:::consumer
    end

    subgraph "Demo Data"
        DemoData["demo/upload.json"]:::demo
    end

    subgraph "Demo/Styleguide Site"
        SG["styleguide/"]:::demo
        Index["index.html"]:::demo

        DemoData --> SG
        SG --> Index
        SG --> StyleCSS
        SG --> ScriptJS
    end

    classDef source fill:#D6EFFF,stroke:#0366d6,color:#0366d6;
    classDef buildTool fill:#D7F9D7,stroke:#28a745,color:#28a745;
    classDef dist fill:#FFF2CC,stroke:#ffc107,color:#856404;
    classDef consumer fill:#E2D4F0,stroke:#6f42c1,color:#6f42c1;
    classDef demo fill:#F0D9FF,stroke:#d63384,color:#d63384;
    classDef config fill:#FFE4B3,stroke:#e36209,color:#e36209;

    click DevCSS "https://github.com/jenswittmann/curlyframework/tree/main/dev/css/"
    click DevJS "https://github.com/jenswittmann/curlyframework/tree/main/dev/js/"
    click Sass "https://github.com/jenswittmann/curlyframework/tree/main/dev/css/"
    click JSB "https://github.com/jenswittmann/curlyframework/blob/main/dev/js/bundle.js"
    click Package "https://github.com/jenswittmann/curlyframework/blob/main/package.json"
    click Workflow "https://github.com/jenswittmann/curlyframework/blob/main/.github/workflows/npm-publish.yml"
    click DemoData "https://github.com/jenswittmann/curlyframework/blob/main/demo/upload.json"
    click SG "https://github.com/jenswittmann/curlyframework/tree/main/styleguide/"
    click Index "https://github.com/jenswittmann/curlyframework/blob/main/index.html"
    click CodeKit "https://github.com/jenswittmann/curlyframework/blob/main/.config.codekit3"
    click EditorCfg "https://github.com/jenswittmann/curlyframework/blob/main/.editorconfig"
    click PrettierRC "https://github.com/jenswittmann/curlyframework/blob/main/.prettierrc"
    click Dependabot "https://github.com/jenswittmann/curlyframework/blob/main/.github/dependabot.yml"
    click PrettierIgnore "https://github.com/jenswittmann/curlyframework/blob/main/.prettierignore"
```
