Microservicio de usuarios. Contiene funcionalidad correspondiente a los usuarios y administradores de ClassConnect.
-
[OBLIGATORIO] Es necesario contar con Docker instalado, ya sea en su versión de escritorio o en su versión de terminal (DockerDesktop o DockerEngine).
-
[OPCIONAL] Contar con el generador de documentos de swagger 'swaggo' instalado.
go install github.com/swaggo/swag/cmd/swag@latest
-
El servicio y su base de datos se encuentran dockerizados, basta con ejecutar el siguiente comando desde la carpeta raíz del proyecto:
docker compose up --build
En caso de querer correr los contenedores en detached mode se debe agregar el flag -d al final de la línea de comandos.
-
Para generar la documentación en swagger basta con ejecutar el siguiente comando desde la carpeta raíz del proyecto:
swag init -d ./cmd,./pkg,./internal
Si no te reconoce swag y ya lo instalaste, probá agregado go al PATH y volvé a probar:
export PATH=$PATH:$(go env GOPATH)/bin
Como resultado se actualizarán los archivos '.yml' y '.json' del directorio docs. Dichos archivos contienen el código necesario para generar la documentación en un editor de swagger.
La generación de un server en localhost para visualizar la documentación no está soportada por el momento.
-
Para abrir phpmyadmin para visualizar las tablas de la base de datos, se debe abrir el siguiente link en el navegador:
http://localhost:9290
-
Están dockerizados. Pararse en el directorio raíz y ejecutar:
./run-tests.sh -
Coverage con codecov: Se muestra en https://app.codecov.io/gh/ClassConnect-Grupo-1/users.
