Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xxczaki/quick-air
☁️ Check air quality near you quickly, using Airly API
https://github.com/xxczaki/quick-air
air air-pollution air-quality airly airly-api api app chartjs data modern nextjs npm particulate-matter pm10 pm25 pollution pwa quality react sensors
Last synced: about 1 month ago
JSON representation
☁️ Check air quality near you quickly, using Airly API
- Host: GitHub
- URL: https://github.com/xxczaki/quick-air
- Owner: xxczaki
- License: mit
- Created: 2019-10-29T20:29:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-01T13:00:03.000Z (almost 5 years ago)
- Last Synced: 2024-05-01T14:30:17.764Z (8 months ago)
- Topics: air, air-pollution, air-quality, airly, airly-api, api, app, chartjs, data, modern, nextjs, npm, particulate-matter, pm10, pm25, pollution, pwa, quality, react, sensors
- Language: JavaScript
- Homepage: https://quick-air.now.sh
- Size: 4.11 MB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# Quick Air ☁️
> Check air quality near you quickly, using [Airly](https://airly.eu/) API
[![Build Status](https://travis-ci.org/xxczaki/quick-air.svg?branch=master)](https://travis-ci.org/xxczaki/quick-air)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)---
## Highlights
- Built with modern technologies
- Great performance
- Shows data in a friendly way
- Utilizes the [airly](https://github.com/xxczaki/airly) package
- Caches data
- Works offline## Development
> Hosted with [now Δ](https://zeit.com/now)
First of all, you will need Airly API key. Get it [here](https://developer.airly.eu/login) for free.
You should then export the `AIRLY_KEY` environment variable.
```
# Start in development mode
$ AIRLY_KEY=yourapikey npm run dev# Build for production
$ AIRLY_KEY=yourapikey npm run build
```**NOTE: If you are using `now dev` command and/or you want to deploy this app to [Zeit Now](https://zeit.co/home), create a `.env.build` file in the root directory and place the `AIRLY_KEY` variable there**
## How it works?
After clicking the "Check air quality" button, the application asks for location access, tries to find the nearest air quality sensor and retrieve data about PM2.5 and PM10. It then classifies the air quality using AIRLY CAQI and prepares charts with pollution forecast :smile:
## Country coverage
At the time of writing this, Airly has sensors in the following countries:
- Poland
- Germany
- Romania
- Denmark
- United Kingdom
- France
- Nederlands
- Belgium
- Switzerland
- Italy
- Spain
- Greece
- Ukraine
- United Arab Emirates
- Georgia### License
MIT