How pmniko/storybook-munisma works
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.