Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 1.48 KB

README.md

File metadata and controls

74 lines (53 loc) · 1.48 KB
Raw

air-quality

This project checks the air quality information of a nearest city to GPS coordinates using iqair API

Features

  • Checks Air Quality Information
  • Run CRON JOB to check “air quality“ for the Paris zone every minute
  • Get the datetime where the paris zone is the most polluted

API Documentation

https://documenter.getpostman.com/view/5916628/VVBXxmFY

How to install

Using Git (recommended)

  1. Clone the project from github.
git clone https://github.com/devwalex/air-quality.git

Using manual download ZIP

  1. Download repository
  2. Uncompress to your desired directory

Install npm dependencies

npm install

Setting up environments

  1. You will find a file named .env.example on root directory of project.
  2. Create a new file by copying and pasting the file and then renaming it to just .env
cp .env.example .env
  1. The file .env is already ignored, so you never commit your credentials.
  2. Change the values of the file to your environment. Helpful comments added to .env.example file to understand the constants.

Running and resetting migrations

  1. To run migrations
npm run migrate
  1. To reset migrations
npm run migrate:reset

How to run

Running API server locally

npm start

You will know server is running by checking the output of the command npm start

Running Tests

npm test

Note: Make sure you set up the test variable in the .env file

Author

Usman Salami

License

MIT