Documentación App Frontend

Bienvenido a la documentación completa del proyecto Miglop.es V2 Frontend.

📚 Índice de Documentación

Para Empezar

1. 00-PROJECT-OVERVIEW.md

   • Resumen general del proyecto
   • Stack tecnológico
   • Arquitectura básica
   • Variables de entorno
   • Scripts disponibles
   • 👉 EMPIEZA AQUÍ

2. 08-ONBOARDING-GUIDE.md

   • Guía completa para nuevos desarrolladores
   • Setup del entorno
   • Primera tarea
   • Workflow de Git
   • 👉 LEE ESTO SI ERES NUEVO EN EL PROYECTO

Arquitectura y Estructura

3. 01-PROJECT-STRUCTURE.md

   • Estructura de carpetas detallada
   • Organización de componentes
   • Layouts y vistas
   • Stores y servicios
   • Convenciones de nomenclatura

4. 04-COMPONENT-PATTERNS.md

   • Patrones de componentes Vue 3
   • Composition API
   • Props y Events
   • Composables
   • DevExtreme y Element Plus
   • Mejores prácticas

Tecnologías y Herramientas

5. 02-LIBRARIES-AND-DEPENDENCIES.md

   • Todas las librerías usadas
   • Configuración de cada librería
   • Versiones y actualizaciones
   • Gestión de dependencias

6. 03-API-COMMUNICATION.md

   • ApiService
   • JwtService
   • Cómo hacer llamadas a la API
   • Manejo de errores
   • Ejemplos de uso
   • Abort Controllers

Operaciones y Mantenimiento

7. 07-DEPLOYMENT.md

   • Estrategia de despliegue
   • Entornos (develop, staging, production)
   • Scripts de build
   • CI/CD
   • Configuración de servidores
   • Troubleshooting

8. 09-UNUSED-COMPONENTS-ANALYSIS.md

   • Análisis de componentes no utilizados
   • Recomendaciones de limpieza
   • Proceso de eliminación segura
   • ⚠️ REVISAR ANTES DE ELIMINAR COMPONENTES

🎯 Guías por Rol

Para Nuevos Desarrolladores

Lectura recomendada en orden:

1. 00-PROJECT-OVERVIEW.md – 30 min
2. 08-ONBOARDING-GUIDE.md – 1 hora
3. 01-PROJECT-STRUCTURE.md – 1 hora
4. 04-COMPONENT-PATTERNS.md – 1 hora
5. 03-API-COMMUNICATION.md – 30 min

Total: ~4 horas de lectura

Para Desarrolladores Existentes

Para añadir nuevas features:

• 04-COMPONENT-PATTERNS.md
• 03-API-COMMUNICATION.md

Para debugging:

• 03-API-COMMUNICATION.md – Sección Troubleshooting
• 07-DEPLOYMENT.md – Sección Troubleshooting

Para deploys:

• 07-DEPLOYMENT.md

Para Tech Leads

Para revisión de arquitectura:

• 01-PROJECT-STRUCTURE.md
• 02-LIBRARIES-AND-DEPENDENCIES.md

Para limpieza de código:

• 09-UNUSED-COMPONENTS-ANALYSIS.md

Para onboarding de equipo:

• 08-ONBOARDING-GUIDE.md

Para DevOps

Para configuración de CI/CD:

• 07-DEPLOYMENT.md
• 00-PROJECT-OVERVIEW.md – Scripts

🔍 Búsqueda Rápida

¿Cómo hacer…?

Pregunta	Documento	Sección
¿Cómo crear un componente?	04-COMPONENT-PATTERNS.md	Estructura de Componentes
¿Cómo llamar a la API?	03-API-COMMUNICATION.md	ApiService
¿Cómo usar un store?	04-COMPONENT-PATTERNS.md	Composables
¿Cómo hacer deploy?	07-DEPLOYMENT.md	Proceso de Despliegue
¿Qué librerías usar para X?	02-LIBRARIES-AND-DEPENDENCIES.md	Por categoría
¿Dónde está el componente Y?	01-PROJECT-STRUCTURE.md	Carpeta src/components
¿Cómo configurar el entorno?	08-ONBOARDING-GUIDE.md	Configuración Inicial

¿Qué es…?

Concepto	Documento	Sección
ApiService	03-API-COMMUNICATION.md	ApiService
Pinia Stores	04-COMPONENT-PATTERNS.md	Composables
DevExtreme	02-LIBRARIES-AND-DEPENDENCIES.md	UI Component Libraries
Router Guards	01-PROJECT-STRUCTURE.md	src/router
Build Scripts	00-PROJECT-OVERVIEW.md	Scripts Disponibles

📊 Estado de la Documentación

Documento	Estado	Última Actualización
00-PROJECT-OVERVIEW.md	✅ Completo	20/10/2025
01-PROJECT-STRUCTURE.md	✅ Completo	20/10/2025
02-LIBRARIES-AND-DEPENDENCIES.md	✅ Completo	20/10/2025
03-API-COMMUNICATION.md	✅ Completo	20/10/2025
04-COMPONENT-PATTERNS.md	✅ Completo	20/10/2025
07-DEPLOYMENT.md	✅ Completo	20/10/2025
08-ONBOARDING-GUIDE.md	✅ Completo	20/10/2025
09-UNUSED-COMPONENTS-ANALYSIS.md	✅ Completo	20/10/2025

🤝 Contribuir a la Documentación

Esta documentación es un documento vivo. Si encuentras:

• Información desactualizada
• Errores o inexactitudes
• Secciones que faltan
• Oportunidades de mejora

Por favor, actualiza la documentación:

1. Edita el archivo markdown correspondiente
2. Haz commit con mensaje descriptivo: docs: actualizar [sección]
3. Crea Pull Request

📧 Contacto

Para preguntas sobre la documentación o el proyecto:

• Tech Lead: [Nombre/Email]
• Maintainer de Docs: [Nombre/Email]
• Canal de Slack/Teams: #frontend-dev

---

Generado: 20/10/2025 Versión: 1.0.0 Proyecto: Miglop.es V2 Frontend Stack: Vue 3 + TypeScript + Vite