How if-7100-2025/preguntas-frontend works
Para diseñar un diagrama de arquitectura preciso de la “Plataforma de Aprendizaje Interactiva” (frontend React/Vite), sigue estos pasos:
Detectar el tipo de sistema y su propósito
• Es una aplicación web de frontend (React + TypeScript + Vite) que consume APIs de un backend (no incluido en el repo).
• Ofrece: publicación y categorización de preguntas (manual / IA), generación de quizzes, manejo de usuarios (auth/roles).
Analizar la estructura de archivos
• src/pages/: vistas principales (home, login, register, quiz, history, moderation, profile, myQuestions, verificationCode, welcome).
• src/components/: UI reusable (sidebar, animatedPage, notification, preguntaForm, quicesForm).
• src/services/: capa de acceso a APIs (http.service, auth.service, quiz.service, question.service, moderation.service, profile.service, home.service, cookies.service).
• src/hooks/: lógica compartida (useApiHandlers, useSessionHandler, notificationHandler; store con Zustand).
• src/contexts/: contextos React (ThemeContext y UserContext).
• assets, models, styles: recursos estáticos, definición de interfaces/modelos, CSS global/local.
Extraer del README
• Stack: React/TypeScript + Vite, ESLint, Zustand para estado global.
• Funcionalidad clave: interacción cliente→servidor, IA externa para categorización.
Componentes principales a incluir
a. Cliente Web (Browser/React App)
• Subcomponentes:
• Views (pages)
• Component Library (components)
• Contextos React (ThemeContext, UserContext)
• Estado global (Zustand stores)
• Custom Hooks
• Herramientas de construcción: Vite
b. Capa de Servicios (HTTP/API Layer)
• http.service.ts (configura peticiones)
• auth.service.ts, quiz.service.ts, question.service.ts, etc.
• cookies.service.ts (persistencia de token/credenciales)
c. Backend / API Gateway (externo; no está en este repo)
• Endpoints REST: /auth, /questions, /quizzes, /moderation, /profile, /home, etc.
• Microservicio IA (podría ser un endpoint de terceros o interno)
d. Almacenamiento y Persistencia
• Base de datos relacional o NoSQL (suponer en backend)
e. Servicios externos
• Servicio IA para categorización de preguntas
• Servicio de notificaciones (si aplica)
Relaciones e interacciones
• El Frontend usa los Custom Hooks y el Store para trigger de acciones.
• Estas llamadas van a la Capa de Servicios → HTTP client → API Backend.
• El Backend puede invocar el Servicio IA para procesar y devolver categorías.
• El estado del usuario (auth, roles) se mantiene en cookies + UserContext.
• UI reacciona a cambios de estado vía React Contexts / Zustand.
• Notificaciones del sistema se manejan en NotificationListener y el hook notificationHandler.
Patrones y principios arquitectónicos
• Separación de responsabilidades: Distinto folder para UI (components, pages), lógica de acceso a datos (services), estado (store), contextos y hooks.
• Container/Presentational: Pages orquestan lógica, Components solo render.
• Unidirectional Data Flow: React → Hooks/Store → Services → API → Store → React.
• Composable: custom hooks + contexts reutilizables.
Guía para dibujar el diagrama
• Usa rectángulos o cajas para cada componente principal (Frontend, Hooks/Stores, Services, Backend API, IA Service, Database).
• Añade flechas direccionales:
• User Interaction → React Pages/Components
• Components → Hooks/Store → Services → HTTP Client → Backend API
• Backend API → IA Service → Backend API
• Backend API → Database
• Auth Service ↔ cookies.service ↔ UserContext
• Colores o formas distintas:
• Azul: Frontend (Pages, Components, Contexts, Stores)
• Verde: Services / HTTP Layer
• Naranja: Backends externos (API, IA, DB)
• Etiquetas claras sobre cada flecha (p. ej. “GET /questions”, “POST /quiz”, “Categorizar pregunta”).
Consejos finales
• Sé detallado en cada subcomponente relevante (ej. listar stores, servicios).
• No sobrecargues: agrupa elementos de la misma capa en un único contenedor con subdivisiones internas.
• Documenta supuestos (por ejemplo: tipo de base de datos, endpoints principales).
• Mantén consistencia en colores y estilos en todo el diagrama.
Con estos elementos, tu diagrama mostrará con claridad la arquitectura de la aplicación frontend, cómo se comunican los distintos módulos internos y cómo éstos encajan con el backend y servicios externos de IA.