This service is part of the AirLifeGoa project. This is the main backend service that interacts with the front end for all kinds of classes related to time series data and user data. This service has 2 services Auth Service & Pollution Service.

Auth service manages all user-related data. It provides the functionality of

• Sign-in/Sign-up
• Mail Verification
• Changing Roles
• Reset Password/Forgot Password
• It uses JWT for authentication and uses MongoDB as DB to store all user data. Passwords are stored in a hashed format which is a result of hashing passwords & some random salt.

The pollution service manages all data-related tasks. It provides the functionality of

• daily, weekly, & monthly Historical data
• Forecasting data
• Adding/Creating data sources
• Adding data points of data sources etc.

Mongodb is used for storing both time series and user data. MongoDB's latest version is optimized for storing time series data.

The walkthrough video for entire codebase is uploaded in the AirLifeGoa youtube channel here.

Use Node version >= 18

  npm install
  npm start

The server will start on port 3002, which can be changed in the index.ts file.

Each routes example API call can be found in this postman project here

Below are some important and mostly used routes

  POST /api/users/sign in

This API call is used for user sign-in.

  POST /API/users/signup

This API call is used for user sign-in.

  POST api/users/change-roles

Below are some important and mostly used routes.
1.

  POST /api/pollution/datasource/create

This API call is used to create a new data source.

Example request body

{
    "id": 18,
    "name": "iitgoa-hostel-3",
    "location": {
        "lat": 14.696700,
        "lng": 124.486050,
        "address": "IIT Goa Hostel 2, Farmagudi, Ponda, Goa, 403401"
    },
    "type": "manual",
    "description": "data source for collecting data in iit goa hostel by students",
    "metrics": [
        "PM10",
        "PM2.5",
        "O2",
        "Wind"
    ],
    "expectedFrequencySeconds": 15,
    "expectedFrequencyType": "seconds"
}

  POST /api/pollution/data

This API call is used for adding new data of a data source.

Example request body

[
    {
        "recordedAt": "2017-04-04T00:00:00+05:30",
        "data": {
            "SO2": 4,
            "NO2": null,
            "PM10": 46,
            "O3": 0,
            "PM2.5": 0,
            "Pb ": 0
        },
        "metadata": {
            "dataSourceId": "1"
        }
    },
    ...
    ...
]

3. 
```http
  POST /api/pollution/data/filter/{dataSourceId}

This API call is used for querying the data of a data source.

  POST /api/pollution/prediction/{dataSourceId}

This API call is used for querying the prediction data of a data source.

  GET /api/pollution/metricdata/{dataSourceId}?metric={metric}

This API call is used for querying metric data like pm10, so2, etc of a data source.

We welcome contributions of any size! please follow the github issues page to get more info about taking on new tasks.

Got stuck. For any more info contact us

Divyansh K - 6 two O 4 Nine Nine ! Eight 0 O or mail at - [email protected]
Pranav B - 9 Three 9 0 O Six 2 Four 8 Zero or mail at - [email protected]