Loading repository data…
Loading repository data…
fjml1983 / repository
Proyecto de caso de estudio realizado en el ITSUR (http://www.itsur.edu.mx/home.php) para servir de BackEnd al proyecto Reporte Coronavirus (https://github.com/fjml1983/reporte-coronavirus)
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
Reporte-coronavirus-api es un proyecto que pretende fungir como BackEnd para la gestión de contactos integrada al proyecto Reporte-Coronavirus mediante una API REST.
Se encuentra desarrollada con Node.js sobre Express.js y se vincula a una base de datos en MySQL server. El script de la base de datos puede ser descargado desde este enlace al script.
Para arrancar el proyecto basta con descargarlo en una carpeta, asegurarse que se tiene la última versión de Node.js y dentro de la carpeta ejecutar los comandos:
npm update para descargar las dependencias del proyecto
npm start para arrancar la API, y se debe obtener el mensaje:
Contacto API Iniciado en el puerto : 8090
Lo cual indica que la API ya se encuentra en funcionamiento y será posible realizar alguna de las siguientes peticiones a esta:
Obtener todos los contactos, eg:
http://localhost:8090/api/contactos
Obtener un contacto por su ID, eg:
http://localhost:8090/api/contacto/1via GET
Insertar un contacto, eg:
http://localhost:8090/api/contacto/guardarvia POST y con un BODY raw de tipo JSON como el siguiente:{email:'nuevo@email.com', mensaje:'Contenido mensaje nuevo'}
Actualizar un contacto, eg:
http://localhost:8090/api/contacto/actualizarvia POST y con un BODY raw de tipo JSON como el siguiente:{id:1, email:'actualizado@email.com', mensaje:'Contenido actualizado'}
Eliminar un contacto, eg:
http://localhost:8090/api/contacto/1via DELETE
Esta puede ser configurada mediante la modificación del archivo dbconfig.js
Actualmente es el puerto 8090 pero puede ser configurado modificando en el archivo api.js la línea:
var port = process.env.PORT || 8090;
Pude accederse a una versión completamente funcional de la API publicada en Heroku y respaldada por ClearDB MySQL mediante las rutas ya descritas sobre el siguiente enlace:
LIVE DEMO: https://reporte-coronavirus-api.herokuapp.com/
Consola heroku: https://dashboard.heroku.com/apps/reporte-coronavirus-api