Appearance
Documentación de Sistema
Bienvenido a la documentación técnica y de sistema de SIVA (Sistema Integral de Vigilantes de Aulas del INAP). Aquí se describe la arquitectura, la API, el modelo de datos, el frontend, el despliegue y la deuda técnica del sistema.
ℹ️ Nota: la documentación funcional para el personal que utiliza la aplicación está en el Manual de Usuario, publicado en su propio sitio.
Contenido
| Documento | Contenido |
|---|---|
| Arquitectura | Visión general, diagramas, flujos y decisiones de diseño. |
| API REST | 164 endpoints con autenticación, roles, parámetros y respuestas. |
| Contrato OpenAPI | Especificación OpenAPI 3.0 descargable. |
| Modelo de datos | Diagrama ER, entidades, enums e índices. |
| Componentes y frontend | Componentes, stores Pinia, rutas y control de acceso. |
| Roles y correcciones recientes | Modelo de roles/permisos y correcciones del flujo de ejercicios. |
| Despliegue y operación | Docker, Podman, pendrive, variables y operación. |
| Guía de contribución | Convenciones, tests y checklist de PR. |
| Deuda técnica | Bugs, inconsistencias y riesgos conocidos. |
Temas específicos
- Asignación rápida — motor de simulación de reparto de vigilantes.
- Bug de TypeORM (ORDER BY) — workaround de paginación con JOINs.
- Despliegue con Docker Compose.
- Podman.
- Versión Windows (pendrive) · Versión Linux (pendrive).