https://github.com/udistrital/convenios_crud
:nerd_face: Practices: CRUD para el negocio de movilidad acadica (Ejercicio introduccion 2019)
https://github.com/udistrital/convenios_crud
practicas
Last synced: 3 months ago
JSON representation
:nerd_face: Practices: CRUD para el negocio de movilidad acadica (Ejercicio introduccion 2019)
- Host: GitHub
- URL: https://github.com/udistrital/convenios_crud
- Owner: udistrital
- Created: 2019-05-29T15:22:45.000Z (about 7 years ago)
- Default Branch: dev
- Last Pushed: 2020-12-15T17:35:43.000Z (over 5 years ago)
- Last Synced: 2024-09-10T19:22:03.700Z (over 1 year ago)
- Topics: practicas
- Language: Go
- Homepage:
- Size: 7.99 MB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# convenios_crud
CRUD para el negocio de convenios en el marco del proyecto Movilidad Académica.
## Especificaciones Técnicas
### Tecnologías Implementadas y Versiones
* [Golang](https://github.com/udistrital/introduccion_oas/blob/master/instalacion_de_herramientas/golang.md)
* [BeeGo](https://github.com/udistrital/introduccion_oas/blob/master/instalacion_de_herramientas/beego.md)
* [Docker](https://docs.docker.com/engine/install/ubuntu/)
* [Docker Compose](https://docs.docker.com/compose/)
### Variables de Entorno
```shell
# parametros de api
CONVENIOS_CRUD_HTTP_PORT=[Puerto de exposición del API]
CONVENIOS_CRUD_RUN_MODE=[Modo de ejecución del API]
# paramametros de bd
CONVENIOS_CRUD_PGUSER=[Usuario de BD]
CONVENIOS_CRUD_PGPASS=[Contraseña del usaurio de BD]
CONVENIOS_CRUD_PGHOST=[URL, Dominio o EndPoint de la BD]
CONVENIOS_CRUD_PGPORT=[Puerto de la BD]
CONVENIOS_CRUD_PGDB=[Nombre de Base de Datos]
CONVENIOS_CRUD_PGSCHEMA=[Nombre del Esquema de Base de Datos]
```
**NOTA:** Las variables se pueden ver en el fichero conf/app.conf y están identificadas con CONVENIOS_CRUD_...
### Ejecución del Proyecto
```shell
#1. Obtener el repositorio con Go
go get github.com/udistrital/convenios_crud
#2. Moverse a la carpeta del repositorio
cd $GOPATH/src/github.com/udistrital/convenios_crud
# 3. Moverse a la rama **develop**
git pull origin develop && git checkout develop
# 4. alimentar todas las variables de entorno que utiliza el proyecto.
CONVENIOS_CRUD_PORT=8080 CONVENIOS_CRUD_SOME_VARIABLE bee run
```
### Ejecución Dockerfile
```shell
# implementado para el sistema de integración continua (CI)
```
### Ejecución docker-compose
```shell
# 1. Obtener repositorio
git clone https://github.com/udistrital/convenios_crud.git
# 2. Ir a la carpeta del repositorio
cd $GOPATH/src/github.com/convenios_crud
# 3. Cambiar a la rama develop
git checkout develop
# 4. Crear red back_end
docker network create back_end
# 5. Ejecutar docker compose
docker-compose up --build
```
### Ejecución Pruebas
Pruebas unitarias
```shell
# En Proceso
```
### Modelo de Datos
[Modelo Relacional convenios_crud](modelo_datos_convenios.png)
[Sql de la base de datos: Convenios BD](https://drive.google.com/file/d/1vf5x8L7vLCJhNGzXEw6h4FiKiUBHmulM/view?usp=sharing)
### Puertos
El servidor se expone en el puerto: 127.0.0.1:8082
Para ver la documentación de swagger: [127.0.0.1:8082/swagger/](http://127.0.0.1:8082/swagger/)
### EndPoints
| |link de prueba |End Point|
|----------------|-------------------------------|------------------------|
| **Obtiene datos asociados a los convenios** |[GetAll](http://127.0.0.1:8082/v1/convenio)| `127.0.0.1:8080/v1/convenio` |
## Estado CI
| Develop | Relese 0.0.1 | Master |
| -- | -- | -- |
| - | - | - |
## Licencia
This file is part of convenios_crud.
convenios_crud 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.
convenios_crud 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 convenios_crud. If not, see https://www.gnu.org/licenses/.