# pmniko/storybook-munisma architecture

> Architecture diagram of the GitHub repository pmniko/storybook-munisma, 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/pmniko/storybook-munisma
- Repository: https://github.com/pmniko/storybook-munisma

## Overview

Para guiar al principal software engineer en la elaboración de un diagrama de arquitectura claro y preciso para el proyecto “Storybook MuniSMA”, seguimos estos pasos:

##### Identificación del tipo y propósito del proyecto
- Es una librería de componentes UI en React con TypeScript expuesta y documentada mediante Storybook.
- No hay backend: es una aplicación front‑end estática (SPA) que se levanta en desarrollo y se empaqueta para producción (GitHub Pages, CDN o servidor estático).

##### Análisis de la estructura de archivos
- Top‑level:
- `.storybook/`: configuración de Storybook (main.ts, preview.ts, preview-head.html)
- `src/`: código React + TypeScript
- `src/components/`: cada componente UI en su propia carpeta con su story (`.stories.tsx`)
- `package.json`, `vite.config.ts`: scripts, dependencias y bundler (Vite)
- `public/`, `index.html`: assets públicos y punto de entrada HTML
- El flujo de desarrollo recorre: Yarn → ejecuta `storybook` o `vite dev` → levanta un servidor local → compila y muestra componentes.

##### Lectura del README
- Confirma listado de componentes (CustomPopUp, Captcha, Table, etc.)
- Propósito: desarrollo rápido y pruebas interactivas de UI aislada
- Público objetivo: diseñadores/desarrolladores que integran o extienden la biblioteca.

##### Componentes principales a reflejar en el diagrama
a. Herramientas de orquestación y build
- Yarn / npm (scripts)
- Vite (bundler/servidor dev)
- Storybook (servidor de historias)
b. Módulos de código
- Config de Storybook (`.storybook/`)
- Componentes React (`src/components/*`)
- Archivo de entrada (`src/main.tsx` y `index.html`)
- Assets estáticos (`public/`, `src/assets/`)
c. Flujo en desarrollo vs. producción
- Dev: `yarn storybook` → Storybook utiliza webpack/vite internamente → renderiza cada story
- Prod: `yarn build` → Vite empaqueta toda la librería + stories estáticas → despliegue

##### Relaciones e interacciones
- Flechas desde Yarn/NPM scripts hacia Vite y Storybook indicando “invoca servidor dev” o “invoca build”.
- Vite/Storybook → toma configuración → consume fuentes en `src/` → genera bundle JS/CSS → sirve a navegador.
- El navegador muestra:
- index.html + bundle (App)
- Storybook UI con paneles de stories, canvas y controles.

##### Patrones y principios arquitectónicos
- Modularización por componente: cada UI es una unidad cohesiva con su historia.
- Separación de preocupaciones:
- Code (React/TS)
- Configuración (Vite, Storybook)
- Assets (públicos)
- Pipeline estática sin backend.

##### Tecnologías clave
- React + TypeScript
- Vite (bundler / hot‑module replacement)
- Storybook (documentación interactiva)
- Yarn Classic
- CSS Modules / CSS global (`index.css`)

##### Pautas para el diagrama
- Usa rectángulos para agrupar:
- “Dev Tooling” (Yarn, Vite, Storybook)
- “Source Code” (`src/`, `public/`)
- “Build Output” (static assets)
- “Browser / End‑User”
- Conecta con flechas dirigidas:
1. Yarn Scripts → Vite & Storybook
2. Vite & Storybook → Source Code
3. Vite/Storybook → Bundle estático
4. Bundle estático → Navegador
- Azul para herramientas de build
- Verde para código fuente
- Naranja para artefactos generados
- Gris para el navegador

##### Elementos mínimos a incluir
- Labels claros: “Yarn Scripts”, “Vite Dev Server”, “Storybook Server”, “React Components”, “Stories”, “Output Bundle”, “Browser UI”
- Flechas con indicaciones de flujo (e.g., “compile”, “serve”, “render”)
- Formas o colores distintos para distinguir:
- Herramientas (círculos)
- Código/Carpetas (rectángulos)
- Artefactos / Output (rombos o íconos de archivo)

Con este plano, el diagrama mostrará con detalle cada pieza: desde el comando `yarn storybook` hasta la interacción final en el navegador, resaltando la independencia de cada componente y el flujo de construcción/despliegue de la librería UI.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Dev Tooling
    subgraph "Dev Tooling"
        direction TB
        YarnScripts(("Yarn Scripts")):::buildTool
        ViteServer(("Vite Dev Server")):::buildTool
        StorybookServer(("Storybook Server")):::buildTool
    end

    %% Source Code
    subgraph "Source Code"
        direction TB
        subgraph "Config Files"
            direction TB
            TSConfig["tsconfig.json"]:::source
            ViteEnv["src/vite-env.d.ts"]:::source
        end
        subgraph ".storybook"
            direction TB
            MainConfig["main.ts"]:::source
            PreviewConfig["preview.ts"]:::source
            PreviewHead["preview-head.html"]:::source
        end
        subgraph "Application"
            direction TB
            EntryHTML["index.html"]:::source
            MainTSX["src/main.tsx"]:::source
            AppTSX["src/App.tsx"]:::source
            AppCSS["src/App.css"]:::source
            IndexCSS["src/index.css"]:::source
        end
        subgraph "Assets"
            direction TB
            PublicDir["public/"]:::source
            AssetsDir["src/assets/"]:::source
        end
        subgraph "Components"
            direction TB
            ComponentsDir["src/components/"]:::source
            subgraph "Captcha Component"
                direction TB
                CaptchaTSX["Captcha.tsx"]:::source
                CaptchaStory["Captcha.stories.tsx"]:::source
            end
            TableTypes["src/components/Table/types.ts"]:::source
        end
    end

    %% Build Output
    subgraph "Build Output"
        direction TB
        Bundle["Output Bundle (JS/CSS)"]:::output
    end

    %% Browser
    subgraph "Browser / End-User"
        direction TB
        BrowserUI["Browser UI"]:::browser
    end

    %% Connections
    YarnScripts -->|invoke dev| ViteServer
    YarnScripts -->|invoke dev| StorybookServer

    ViteServer -->|load config & source| ConfigFiles
    ViteServer -->|load config & source| Application
    ViteServer -->|load config & source| Assets
    ViteServer -->|load config & source| ComponentsDir

    StorybookServer -->|load config & source| MainConfig
    StorybookServer -->|load config & source| PreviewConfig
    StorybookServer -->|load config & source| PreviewHead
    StorybookServer -->|load source components| ComponentsDir

    ViteServer -->|compile| Bundle
    StorybookServer -->|compile| Bundle

    Bundle -->|serve| BrowserUI
    BrowserUI -->|render| Application

    %% Click Events
    click YarnScripts "https://github.com/pmniko/storybook-munisma/blob/main/package.json"
    click ViteServer "https://github.com/pmniko/storybook-munisma/blob/main/vite.config.ts"
    click StorybookServer "https://github.com/pmniko/storybook-munisma/tree/main/.storybook/"
    click MainConfig "https://github.com/pmniko/storybook-munisma/blob/main/.storybook/main.ts"
    click PreviewConfig "https://github.com/pmniko/storybook-munisma/blob/main/.storybook/preview.ts"
    click PreviewHead "https://github.com/pmniko/storybook-munisma/blob/main/.storybook/preview-head.html"
    click EntryHTML "https://github.com/pmniko/storybook-munisma/blob/main/index.html"
    click MainTSX "https://github.com/pmniko/storybook-munisma/blob/main/src/main.tsx"
    click IndexCSS "https://github.com/pmniko/storybook-munisma/blob/main/src/index.css"
    click PublicDir "https://github.com/pmniko/storybook-munisma/tree/main/public/"
    click AssetsDir "https://github.com/pmniko/storybook-munisma/tree/main/src/assets/"
    click ComponentsDir "https://github.com/pmniko/storybook-munisma/tree/main/src/components/"
    click CaptchaTSX "https://github.com/pmniko/storybook-munisma/blob/main/src/components/Captcha/Captcha.tsx"
    click CaptchaStory "https://github.com/pmniko/storybook-munisma/blob/main/src/components/Captcha/Captcha.stories.tsx"
    click TableTypes "https://github.com/pmniko/storybook-munisma/blob/main/src/components/Table/types.ts"
    click TSConfig "https://github.com/pmniko/storybook-munisma/blob/main/tsconfig.json"
    click ViteEnv "https://github.com/pmniko/storybook-munisma/blob/main/src/vite-env.d.ts"

    %% Styles
    classDef buildTool fill:#AED6F1,stroke:#1F618D,color:#1F618D,stroke-width:1px;
    classDef source fill:#ABEBC6,stroke:#1D8348,color:#1D8348,stroke-width:1px;
    classDef output fill:#F5CBA7,stroke:#D35400,color:#D35400,stroke-width:1px;
    classDef browser fill:#D5DBDB,stroke:#566573,color:#566573,stroke-width:1px;
```
