SNIB Middleware

Esta aplicación es responsable de crear el API necesaria para SPECIES.

En docs/api-doc.md se puede consultar la documentación de la API.

Uso

Clonar el repositorio

  $ git clone https://bitbucket.org/conabio_c3/snib-middleware.git

Después instalar la aplicación y lanzarla

  $ cd snib-middleware
  $ npm install
  $ npm start

Nota: Hay que conifgurar la conexión a la base de datos en el archivo config.js.

Desarrollo

Cuando se esté desarrollando nuevos endpoints para la API se recomienda documentarlos en el archivo api/swagger/swagger.yaml, esto se puede hacer con cualquier editor de texto o con el editor de Swagger. Después de documentar el nuevo endpoint se puede usar el comando npm run api-docs para generar el nuevo archivo de documentación del API y npm run docs para documentar los controladores.

Se recomienda antes de hacer un push al repositorio correr el comando npm run lint para respetar la escritura del código.

Se recomienda usar un debugger sobre console.log, en cada uno de los archivos de controladores deben de tener un debugger.