# itsjuanit/tandem-challenge architecture

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

- Interactive diagram: https://gitdiagram.com/itsjuanit/tandem-challenge
- Repository: https://github.com/itsjuanit/tandem-challenge

## Overview

Para crear un diagrama de arquitectura claro y preciso para este proyecto de formulario dinámico en Vue 3, sigue estos pasos adaptados a su estructura y propósito:

##### Identificación del tipo de proyecto y propósito
- Proyecto: Single-Page Application (SPA) frontend construido con Vue 3, TypeScript y Vite.
- Propósito: Generar formularios completamente dinámicos a partir de un archivo JSON de configuración, validarlos en tiempo real y simular persistencia de datos en `localStorage`.

##### Análisis de la estructura de ficheros
- index.html: punto de entrada de la SPA.
- vite.config.ts: configuración de Vite (dev server, bundling).
- src/main.ts: arranca la app Vue y monta Vuetify.
- src/App.vue: componente raíz.
- src/components:
- DynamicForm.vue: orquesta la lectura de config y renderizado de campos.
- FieldRenderer.vue: renderiza cada campo según su tipo.
- src/config/formConfig.json: JSON con definición de campos, validaciones y metadatos.
- src/utils/configLoader.ts: servicio que carga y parsea el JSON.
- src/utils/validations.ts: lógica de validación por campo y validación cruzada.
- localStorage: almacena datos al “enviar” el formulario.

##### Puntos clave en el README
- Flujo: cargar JSON → renderizar formulario → validaciones en tiempo real → persistencia en localStorage.
- Tech stack: Vue 3, TypeScript, Vite, Vuetify, localStorage.

##### Componentes principales para el diagrama
A. Cliente (Browser)
- Vite Dev Server (durante desarrollo)
- Bundled SPA (index.html + assets estáticos + JavaScript)
B. Módulos de la aplicación
1. Entry Point
- index.html
- main.ts
– Carga Vue, Vuetify y monta App.vue
2. Módulo de Configuración
- configLoader.ts
- formConfig.json
– Lee y expone la definición del formulario
3. Componente Dinámico
- DynamicForm.vue
– Itera sobre `fields`, llama a FieldRenderer
4. Renderizado de Campos
- FieldRenderer.vue
– Distingue tipos (text, number, email…) y aplica binding
5. Validaciones
- validations.ts
– `validateFieldValue(field, value, formData)`
– Validación por regla y validación cruzada
6. Persistencia Local
- localStorage API
– Guarda `formData` en el navegador

C. Dependencias Externas
- Vue 3 (runtime + reactividad)
- Vuetify 3 (UI components)
- Vite (bundler / dev server)

##### Relaciones e interacciones
- El navegador solicita el bundle (index.html + JS) al servidor Vite o al hosting estático.
- main.ts inicializa la app y carga App.vue.
- App.vue invoca configLoader para traer formConfig.json.
- DynamicForm recorre la configuración y genera uno o varios FieldRenderer.
- Cada FieldRenderer emite eventos (`input`, `change`) hacia DynamicForm.
- DynamicForm invoca validations.ts para cada cambio y recopila errores.
- Al submit:
- Si hay errores → mensaje de alerta.
- Si no hay errores → escribe formData en localStorage → notifica éxito.

##### Patrón y principios arquitectónicos
- Component-driven architecture: cada concern (config, render, validación) separado en un módulo/componente.
- Unidirectional data flow en Vue: props ↓, eventos ↑.
- Single Responsibility: configLoader y validations como servicios independientes.
- Extensibilidad: nueva regla de validación o tipo de campo → basta agregar al JSON y/o crear un nuevo case en FieldRenderer/validations.

##### Guía para el diagrama
- Usa cajas/rectángulos para cada componente o servicio.
- Conecta con flechas direccionales (→) que representen llamadas o flujo de datos:
1. Browser → index.html
2. index.html → main.ts → App.vue
3. App.vue → configLoader → formConfig.json
4. App.vue → DynamicForm
5. DynamicForm → FieldRenderer
6. FieldRenderer → DynamicForm (eventos)
7. DynamicForm → validations.ts → DynamicForm
8. DynamicForm → localStorage
- Diferencia con colores:
- Azul: módulos Vue (App.vue, DynamicForm, FieldRenderer)
- Verde: servicios utilitarios (configLoader, validations)
- Naranja: recursos estáticos (formConfig.json, localStorage)
- Gris: infra (Vite Dev Server / Hosting)
- Añade leyenda con stack tecnológico (Vue 3, TypeScript, Vite, Vuetify).

##### Elementos imprescindibles
- Etiquetas claras (nombres de componentes/servicios).
- Flechas con direccionalidad y notas breves (por ejemplo, “load JSON”, “emit input”, “write to localStorage”).

Con esta guía el diagrama mostrará de forma detallada y ordenada cómo fluye la configuración desde el JSON hasta la UI, cómo se gestionan las validaciones y cómo se simula la persistencia, reflejando la esencia arquitectónica de la aplicación.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Infrastructure
    subgraph "Infrastructure"
        Browser["Browser"]:::infra
        DevServer["Vite Dev Server / Hosting"]:::infra
    end

    %% Entry Point
    subgraph "Entry Point"
        HTML["index.html"]:::entry
        MainTS["main.ts"]:::entry
    end

    %% Vue Components
    subgraph "Vue Components"
        App["App.vue"]:::vue
        Dynamic["DynamicForm.vue"]:::vue
        Field["FieldRenderer.vue"]:::vue
    end

    %% Services
    subgraph "Services"
        ConfigLoader["configLoader.ts"]:::service
        Validations["validations.ts"]:::service
    end

    %% Resources
    subgraph "Resources"
        ConfigJSON["formConfig.json"]:::resource
        LocalStorage["localStorage"]:::resource
    end

    %% Technology Stack
    subgraph "Tech Stack"
        Vue3["Vue 3"]
        TS["TypeScript"]
        Vite["Vite"]
        Vuetify["Vuetify"]
    end

    %% Connections
    Browser -->|"GET index.html"| HTML
    DevServer -->|"serves bundle"| Browser
    HTML -->|"loads main.ts"| MainTS
    MainTS -->|"mount App.vue"| App
    App -->|"load JSON"| ConfigLoader
    ConfigLoader -->|"read config"| ConfigJSON
    App -->|"render form"| Dynamic
    Dynamic -->|"create field"| Field
    Field -->|"emit input"| Dynamic
    Dynamic -->|"validate field"| Validations
    Validations -->|"return result"| Dynamic
    Dynamic -->|"write data"| LocalStorage

    %% Click Events
    click HTML "https://github.com/itsjuanit/tandem-challenge/blob/main/index.html"
    click MainTS "https://github.com/itsjuanit/tandem-challenge/blob/main/src/main.ts"
    click App "https://github.com/itsjuanit/tandem-challenge/blob/main/src/App.vue"
    click ConfigLoader "https://github.com/itsjuanit/tandem-challenge/blob/main/src/utils/configLoader.ts"
    click ConfigJSON "https://github.com/itsjuanit/tandem-challenge/blob/main/src/config/formConfig.json"
    click Dynamic "https://github.com/itsjuanit/tandem-challenge/blob/main/src/components/DynamicForm.vue"
    click Field "https://github.com/itsjuanit/tandem-challenge/blob/main/src/components/FieldRenderer.vue"
    click Validations "https://github.com/itsjuanit/tandem-challenge/blob/main/src/utils/validations.ts"
    click DevServer "https://github.com/itsjuanit/tandem-challenge/blob/main/vite.config.ts"

    %% Styles
    classDef vue fill:#bbdefb,stroke:#1e88e5,color:#0d47a1
    classDef service fill:#c8e6c9,stroke:#2e7d32,color:#1b5e20
    classDef resource fill:#ffe0b2,stroke:#ef6c00,color:#e65100
    classDef infra fill:#eeeeee,stroke:#757575,color:#424242
    classDef entry fill:#e3f2fd,stroke:#42a5f5,color:#0d47a1
    classDef default stroke:#333,stroke-width:1px,color:#000
```
