ahmedgamal47 / atmosphere-api Goto Github PK

Welcome to the Atmosphere API repository! This is a RESTful API built using NestJs, Express, and MongoDB.

The Atmosphere API provides simple endpoint for retrieving air quality data,. It utilizes the IQAir API to provide air quality information based on latitude and longitude.

To install the Atmosphere API, follow these steps:

1 - Clone the repository:

git clone https://github.com/ahmedgamal47/atmosphere-api.git

2 - Install the dependencies:

cd atmosphere-api
npm install

3 - Create a .env file based on the .env.example file and set the appropriate environment variables:

MONGO_HOST=mongodb://db:27017/iqAir
iqAir_apiKey=your_iqair_api_key_here
iqAir_baseUrl=https://api.airvisual.com

you can create your IQAir credentials from here IQAir

4 - Start the server:

npm run start:dev

Alternatively, you can use Docker Compose to run the Atmosphere API. Simply run:

docker-compose up

This Api supports OpenAPI/Swagger documentation, you can visit the baseUrl and it will show up Swagger UI Documentation

http://localhost:3000/

# unit tests
$ npm run test

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Nest is MIT licensed.