readme.md

Danger Backend

Prerequisites

You need to have Node.js and yarn installed.

You need an .env file in order to run this project. It looks like this:

COVID_PERU_CASES_1=https://geocatmin.ingemmet.gob.pe/arcgis/rest/services/COVIT_PERU_REGION/MapServer/0/query
EMAIL_SENDER=
EMAIL_RECEPTOR_1=
EMAIL_RECEPTOR_2=
HOME_URL=https://acecom-danger.herokuapp.com/
MONGO=
PASSWORD=
PORT=
TIME=

Setup

In order to install and use this project please run the following commands in your terminal:

yarn
yarn service

This will run the development server, so you will a message as follows:

yarn run v1.22.4
$ nodemon --exec babel-node -r dotenv/config src/bin/index
[nodemon] 2.0.3
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `babel-node -r dotenv/config src/bin/index`
APP RUNNING AT PORT XXXX
We are connected with the database!

Usage

There are four endpoints implemented:

1. Home: / , it has a get method. It is just decorative.

2. DataInEachDay: /dataInEachDay, it has a post method. This method has two different functionalities, according to the payload you send, here are some examples:

   • To get the data from Peru (corresponding to an specific date):

     {
       "args": {
         "name": "perú"
       }
     }

   • To get the data from a department (corresponding to an specific date):

     {
       "args": {
         "name": "departmentName"
       }
     }

   • In case of success, for the payload previously, you will get the following responses (respectively):

     1. Data from Peru:

     {
       "error": false,
       "message": [
         {
           "cases": 1, 
           "createdAt": "YYYY-MM-DD",
           "deaths": 0,
           "discarded": 154,
           "recovered": 0
         }
       ]
     }

     2. Data from any department:

     {
       "error": false,
       "message": [
         {
           "cases": 1,
           "createdAt": "YYYY-MM-DD",
           "deaths": 0
         }
       ]
     }

3. DataPerDay: /dataPerDay, it has a post method. This has two different functionalities, according to the payload you send, here are some examples:

   • To get the accumulated data from an specific date from Peru:

     {
       "args": {
         "date": "YYYY-MM-DD"
       }
     }

   • In case of success you will get the following response:

     {
       "error": false,
       "message": {
         "departmentsData": {
           "departments": [
             {
               "name": "departmentName",
               "totalCases": 111,
               "totalDeaths": 0
             }
           ]
         },
         "totalData": {
           "totalCases": 145,
           "totalDeaths": 0,
           "totalDiscarded": 2930,
           "totalRecovered": null
         }
       }
     }

4. TotalData: /totalData, it has a post method. This method has two different functionalities, according to the payload you send, here are some examples:

   • To get all the data from Peru:

     {
       "args": {
         "name": "perú"
       }
     }

   • To get all the data from a department:

     {
       "args": {
         "name": "departmentName"
       }
     }

   • In case of success, for the payload previously, you will get the following responses (respectively):

     1. Data from Peru:

     {
       "error": false,
       "message": [
         {
           "createdAt": "YYYY-MM-DD",
           "totalCases": 1, 
           "totalDeaths": 0,
           "totalDiscarded": 154,
           "totalRecovered": 0
         }
       ]
     }

     2. Data from any department:

     {
       "error": false,
       "message": [
         {
           "createdAt": "YYYY-MM-DD",
           "totalCases": 1,
           "totalDeaths": 0
         }
       ]
     }

Notes

1. In case of error you will get a generic error as follows (plus a 500 error):

   {
     "error": true,
     "message": "Error message"
   }

2. Be aware of the last 20 lines of the /src/bin/index.js file, it has a crontab that will try to update the database at 09:00 pm, we suggest to comment these lines, in order to avoid generating an error if there isn't a .env file.

Authors:

• Anthony Luzquiños - Initial Work - Database - Deployment - Documentation - AnthonyLzq.