sga_mid_practicas_academicas

README

Prácticas Académicas - SGA MID

API MID intermediaria entre el cliente SGA y las APIs de solicitud docente, proyecto académico y terceros con los endpoints requeridos para la gestión de la información necesaria en los módulos del SGA cliente.

Especificaciones Técnicas

Tecnologías Implementadas y Versiones

• Golang
• BeeGo
• Docker
• Docker Compose

Variables de Entorno

SGA_PRACTICAS_ACAD_MID_HTTP_PORT: [Puerto de ejecución API]
ESPACIOS_ACADEMICO_SERVICE: [Servicio API ESPACIOS_ACADEMICO]
GOOGLE_MID: [Servicio API GOOGLE_MID]
PARAMETRO_SERVICE: [Servicio API PARAMETROS]
PROYECTO_ACADEMICO_SERVICE: [Servicio API PROYECTO_ACADEMICOS]
SOLICITUD_DOCENTE_SERVICE: [Servicio API SOLICITUD_DOCENTE]
TERCEROS_SERVICE: [Servicio API TERCEROS]

NOTA: Las variables se pueden ver en el fichero conf/app.conf.

Ejecución del Proyecto

#1. Obtener el repositorio con Go
go get github.com/udistrital/sga_mid_practicas_academicas

#2. Moverse a la carpeta del repositorio
cd $GOPATH/src/github.com/udistrital/sga_mid_practicas_academicas

# 3. Moverse a la rama **develop**
git pull origin develop && git checkout develop

# 4. alimentar todas las variables de entorno que utiliza el proyecto.
SGA_MID_HTTP_PORT=8080 RULER_URL=127.0.0.1:27017 SGA_MID_PRACTICAS_ACAD_SOME_VARIABLE=some_value bee run

# 5. Ejecutar aplicacion en local y generar documentacion swagger
bee run -downdoc=true -gendoc=true

Ejecución Dockerfile

# docker build --tag=sga_mid_practicas_academicas . --no-cache
# docker run -p 80:80 sga_mid_practicas_academicas

Ejecución docker-compose

#1. Clonar el repositorio
git clone -b develop https://github.com/udistrital/sga_mid_practicas_academicas

#2. Moverse a la carpeta del repositorio
cd sga_mid_practicas_academicas

#3. Crear un fichero con el nombre **custom.env**
# En windows ejecutar:* ` ni custom.env`
touch custom.env

#4. Crear la network **back_end** para los contenedores
docker network create back_end

#5. Ejecutar el compose del contenedor
docker-compose up --build

#6. Comprobar que los contenedores estén en ejecución
docker ps

Ejecución Pruebas

Pruebas unitarias

# En Proceso

Estado CI

Develop	Relese 0.0.1	Master

Licencia

This file is part of sga_mid_practicas_academicas.

sga_mid_practicas_academicas is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

sga_mid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with sga_mid. If not, see https://www.gnu.org/licenses/.