# vilmaponce/sprint-4-vilma-ponce architecture

> Architecture diagram of the GitHub repository vilmaponce/sprint-4-vilma-ponce, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vilmaponce/sprint-4-vilma-ponce
- Repository: https://github.com/vilmaponce/sprint-4-vilma-ponce

## Overview

Este proyecto es una aplicación web frontend construida con React y Vite, diseñada para buscar y administrar personajes de la serie Rick and Morty. La aplicación permite realizar búsquedas de personajes, visualizar detalles, gestionar favoritos (guardados en localStorage) y presenta un diseño responsive con TailwindCSS, además de utilizar Axios para las llamadas a la API.

A continuación, se detallan los pasos e instrucciones para dibujar un diagrama de arquitectura del sistema que represente fielmente la estructura y propósito del proyecto:

##### Componentes Principales del Sistema
- Navegador del usuario: Representa el entorno de ejecución (cliente) donde se carga la aplicación.
- Interfaz de Usuario (UI):
- La carpeta "src" contiene la aplicación React, donde se incluye el archivo principal (main.jsx) que renderiza la aplicación.
- Dentro de "src", el componente raíz (App.jsx) organiza la estructura de la aplicación.
- La carpeta "components" engloba componentes reutilizables como Header, Footer, CharacterCard, FavoritesList, FavoritesModal, Loader y SearchForm.
- Páginas:
- La carpeta "pages" agrupa las vistas principales, concretamente "Home" y "Favorites". Estas páginas se gestionan a través de React Router para la navegación entre ellas.
- Libro de Servicios:
- La carpeta "services" contiene el archivo "api.js", el cual se encarga de hacer peticiones HTTP a la API de Rick and Morty utilizando Axios.
- Hooks y Persistencia:
- La carpeta "hooks" (por ejemplo, el hook useLocalStorage.js) encapsula la lógica para gestionar la persistencia de datos en el localStorage.
- Estilos y Recursos:
- Se incluyen archivos CSS (App.css, index.css) y recursos estáticos en "public" o "src/assets" para manejar estilos (con TailwindCSS) e imágenes.

##### Relaciones e Interacciones
- Flujo de datos:
- El usuario interactúa con la UI (por ejemplo, mediante el SearchForm) que desencadena peticiones a la API a través del servicio definido en "api.js".
- Los resultados de la búsqueda se muestran usando componentes como CharacterCard.
- Al agregar un personaje a favoritos, se actualiza el estado en el frontend y se persiste en localStorage mediante el hook useLocalStorage.
- La navegación entre páginas (Home y Favorites) se gestiona con React Router, con componentes Header y Footer presentes en las vistas.
- Comunicación con servicios externos:
- Aunque la API a la que se conecta es externa (la de Rick and Morty), su integración se encapsula en el servicio API central, simplificando el manejo de errores y el formateo de respuestas.

##### Patrones y Principios Arquitectónicos
- Composición de Componentes y Reutilización: La estructura basada en React favorece la separación de la UI en componentes pequeños y reutilizables.
- Abstracción del Servicio: El archivo "api.js" encapsula la comunicación con la API externa, aislando la lógica de negocio de las llamadas HTTP.
- Gestión de Estado y Persistencia Local: La utilización de hooks, principalmente el useLocalStorage, se integra con useState y useEffect para mantener el estado de la aplicación y la persistencia de datos entre sesiones.
- Diseño Modular y Responsive: La separación en páginas, componentes y assets facilita la escalabilidad y el mantenimiento, mientras que el uso de TailwindCSS asegura un diseño adaptable a distintos dispositivos.

##### Tecnologías y Herramientas Relevantes
- React y React Router para la construcción y navegación de la UI.
- Vite para desarrollo y construcción, garantizando tiempos de compilación rápidos.
- Axios para la realización de peticiones HTTP.
- TailwindCSS para el diseño y estilos.
- react-toastify para las notificaciones en la interfaz.
- localStorage para la persistencia de la lista de favoritos.

##### Recomendaciones para el Diagrama
- Incluir cajas o bloques para cada uno de los siguientes componentes:
- Cliente (Navegador) → Renderizado de la aplicación.
- Entrada: main.jsx y App.jsx como contenedor principal.
- UI Componentes: Listar y etiquetar componentes (Header, Footer, CharacterCard, FavoritesList, FavoritesModal, Loader y SearchForm).
- Páginas: Representar las páginas "Home" y "Favorites", mostrando la ruta/navegación entre ellas.
- Servicios: Añadir el servicio "api.js" ubicado en la carpeta de servicios, con flechas que indiquen su comunicación con la API de Rick and Morty.
- Hooks de Persistencia: Mostrar el hook (useLocalStorage) y su función de guardar datos en localStorage.
- Utilizar flechas direccionales para indicar el flujo de datos, por ejemplo:
- Desde el SearchForm a api.js para la solicitud de datos.
- Desde api.js a componentes que muestran los resultados (como CharacterCard).
- Desde componentes hacia useLocalStorage para la gestión de favoritos.
- Diferenciar visualmente los bloques:
- Usar colores o formas distintos para agrupar lógica de presentación (componentes y páginas) frente a lógica de negocio (servicios y hooks).
- Etiquetar claramente las interacciones con el API externo y la persistencia en localStorage.
- Agregar notas adicionales donde se indique el uso de bibliotecas específicas (React, Vite, Axios, TailwindCSS, react-toastify).

##### Personalización del Diagrama para Este Proyecto
- Dado que se trata de una aplicación frontend enfocada en la búsqueda y manejo de favoritos, enfoca el diagrama en la interacción directa del usuario con la interfaz.
- Destaca la separación entre UI (componentes y páginas) y la lógica de negocio (servicios y hooks).
- Asegúrate de clarificar cómo los componentes de la UI se comunican entre sí y con los servicios externos a través de eventos y estados gestionados por React.

Siguiendo esta guía, el diagrama final debe ser muy detallado, con cada componente y módulo claramente identificado, y con flechas que indiquen la dirección del flujo de datos y dependencias. Esto permitirá visualizar en detalle cómo la aplicación se estructura y cómo fluyen la información y las interacciones entre cada parte del sistema, lo que facilitará tanto la comprensión como la posibilidad de futuras mejoras o mantenimientos en el proyecto.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    A["Navegador (Cliente)"]:::client

    %% Application Entry
    subgraph "Application Entry"
        B["Renderizado de la aplicación (main.jsx)"]:::entry
        C["Contenedor Principal (App.jsx)"]:::entry
    end

    %% Styles y Recursos
    subgraph "Estilos y Recursos"
        O1["Estilos Globales (App.css)"]:::styles
        O2["Estilos Globales (index.css)"]:::styles
        O3["Recursos y Assets (src/assets)"]:::styles
    end

    %% UI Components
    subgraph "Componentes de UI"
        D["Header"]:::ui
        E["Footer"]:::ui
        F["SearchForm"]:::ui
        G["CharacterCard"]:::ui
        H["FavoritesList"]:::ui
        I["FavoritesModal"]:::ui
        J["Loader"]:::ui
    end

    %% Pages
    subgraph "Páginas"
        K["Home"]:::pages
        L["Favorites"]:::pages
    end

    %% Business Logic
    subgraph "Lógica de Negocio"
        M["API Service (api.js)"]:::business
        N["useLocalStorage Hook"]:::business
    end

    %% External API
    subgraph "External API"
        P["Rick and Morty API"]:::external
    end

    %% Relaciones entre componentes
    A --> B
    B --> C
    %% Cargando recursos de estilos
    B --> O1
    B --> O2
    B --> O3

    %% App compone la UI y las páginas
    C --> D
    C --> E
    C --> K
    C --> L

    %% Páginas componen la UI interna
    K --> F
    K --> G
    L --> H
    L --> I

    %% Interacciones con servicios
    F -->|"fetch"| M
    F -->|"loading"| J
    M -->|"response"| G
    M -->|"HTTP"| P

    %% Gestión de favoritos
    G -->|"favoriteUpdate"| N
    N -->|"persist"| H
    N -->|"persist"| I

    %% Estilos de nodos
    classDef client fill:#FDEDEC,stroke:#D35400,stroke-width:2px;
    classDef entry fill:#D6EAF8,stroke:#2874A6,stroke-width:2px;
    classDef ui fill:#EDBB99,stroke:#D35400,stroke-width:2px;
    classDef pages fill:#ABEBC6,stroke:#27AE60,stroke-width:2px;
    classDef business fill:#F9E79F,stroke:#F1C40F,stroke-width:2px;
    classDef styles fill:#E8DAEF,stroke:#8E44AD,stroke-width:2px;
    classDef external fill:#D5F5E3,stroke:#2ECC71,stroke-width:2px;

    %% Click Events
    click A "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/index.html"
    click B "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/main.jsx"
    click C "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/App.jsx"
    click D "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/components/Header.jsx"
    click E "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/components/Footer.jsx"
    click F "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/components/SearchForm.jsx"
    click G "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/components/CharacterCard.jsx"
    click H "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/components/FavoritesList.jsx"
    click I "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/components/FavoritesModal.jsx"
    click J "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/components/Loader.jsx"
    click K "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/pages/Home.jsx"
    click L "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/pages/Favorites.jsx"
    click M "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/services/api.js"
    click N "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/hooks/useLocalStorage.js"
    click O1 "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/App.css"
    click O2 "https://github.com/vilmaponce/sprint-4-vilma-ponce/blob/main/src/index.css"
    click O3 "https://github.com/vilmaponce/sprint-4-vilma-ponce/tree/main/src/assets"
```
