Calidu API
En este repositorio podrá encontrar todo el backend correspondiente a la aplicación web Calidú., en complemento con el repositorio Frontend este software permite la implementación de control de calidad en tiempo real y seguimiento a lista de asistencia para las entidades educativas que utilicen la modalidad sincrónica (clases en vivo de manera remota o presencial).
Requisitos de instalación
- Docker (versión 20.10 o superior): utilizado para construir una clase de "máquina virtual" para ejecutar la aplicación con todas sus dependencias y utilidades. Información de instalación aquí
- Docker-composer (versión 1.29 o superior): utilizado para ejecutar todos los contenedores Docker de manera generalizada (orquestador). Información de instalación aquí
- GNU Make: es un comando originario de linux que puede ser instalado en los diferentes sistemas operativos, su funcion principal en Calidú es ejecutar fácilmente tareas de docker para cargar, detener o borrar la aplicación.
Instalación
NOTA: Esta API está construida mediante contenedores Docker y se usa el fichero .makefile
para ejecutar comandos de docker. Consulte el archivo makefile para ver todas las opciones disponibles.
- Cree un archivo
.env
en la raiz de su proyecto con las variables de entorno proporcionadas por el administrador - Ejecute
make install
- Ejecute
make ps
odocker ps
para visualizar los puertos que estan siendo utilizados - ¡Listo! puede hacer uso de la API