🗂️ json-reportes-back

Servicio para convertir datos en json a un template customizable para generar reportes, por ahora solo genera pdfs y markdown

📖 Documentacion adicional

🎉 Uso

La prueba mas simple para saber si la instalacion resulto es ejecutar una llamada REST de tipo GET con la url http://localhost:5000/vivo
A falta de un front, solo se puede usar haciendo llamadas rest desde una herramienta que lo facilite, para ello se deja una coleccion de Postman ubicado en: src/json_reportes.postman_collection.json
Leer las descripciones de las request de Postman que indican como python toma las variables de los request
Se deja como ejemplo un template html con css y un json de datos en la ruta /src/ejemplo_template/

📜 Scripts

Se dejan scripts para facilitar el manejo del proyecto, la cual contiene scripts para docker, heroku, python, etc. Para ejecutarlos hay que pararse en la ruta raiz del proyecto y llamar el script desde ahi, ejemplo: ./scripts/docker/build.sh

📦 Despliegue

La aplicacion se despliega de forma automatica utilizando CircleCI cada vez que se realiza un merge a la rama master, para ello utiliza los scripts dentro de la carpeta scripts/, es decir que ejecutar los scripts manualmente es similar a lo que ejecutan las tasks dentro de los jobs del pipeline de circleci

Este despliegue consiste en:

Docker:

Construir una nueva imagen de docker
Crear un tag para la imagen con la version acortada del commit de github
Subir la imagen a docker hub
Actualizar la version latest existente en docker hub a esta ultima

Heroku:

Construir una imagen de docker espificamente para heroku
Subir la imagen creada al registry de heroku
Desplegar la imagen generada

💸 Heroku

Ingresar aqui para probar la aplicacion.
Al agregarle /variables al final de la URL se puede observar la version desplegada en el atributo del json respuesta version

🌎 Paginas

😁 Autor

Brian Lobo

Github: brianwolf
Docker Hub: brianwolf94

brianwolf / json-reportes-back Goto Github PK