Skip to content

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

DocumentoContenido
ArquitecturaVisión general, diagramas, flujos y decisiones de diseño.
API REST164 endpoints con autenticación, roles, parámetros y respuestas.
Contrato OpenAPIEspecificación OpenAPI 3.0 descargable.
Modelo de datosDiagrama ER, entidades, enums e índices.
Componentes y frontendComponentes, stores Pinia, rutas y control de acceso.
Roles y correcciones recientesModelo de roles/permisos y correcciones del flujo de ejercicios.
Despliegue y operaciónDocker, Podman, pendrive, variables y operación.
Guía de contribuciónConvenciones, tests y checklist de PR.
Deuda técnicaBugs, inconsistencias y riesgos conocidos.

Temas específicos

SIVA — Sistema Integral de Vigilantes de Aulas