Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xxczaki/air-radar
Generate air quality reports from anywhere in the world and share them with your friends!
https://github.com/xxczaki/air-radar
a11y air air-pollution air-quality airly api i18n mongodb mongodb-atlas next nextjs react recoil vercel waqi web-app web-application
Last synced: 28 days ago
JSON representation
Generate air quality reports from anywhere in the world and share them with your friends!
- Host: GitHub
- URL: https://github.com/xxczaki/air-radar
- Owner: xxczaki
- License: mit
- Created: 2020-07-22T20:55:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-16T21:07:10.000Z (over 4 years ago)
- Last Synced: 2024-05-01T14:30:08.676Z (8 months ago)
- Topics: a11y, air, air-pollution, air-quality, airly, api, i18n, mongodb, mongodb-atlas, next, nextjs, react, recoil, vercel, waqi, web-app, web-application
- Language: TypeScript
- Homepage: https://air-radar.vercel.app
- Size: 6.01 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
**Disclaimer: Work in progress**
---
# Air Radar ☁️
> Generate air quality reports from anywhere in the world and share them with your friends!
[](https://travis-ci.org/xxczaki/air-radar)
[](https://github.com/xojs/xo)
[](https://github.com/styled-components/styled-components)
---
## Highlights
- Blazing fast (uses incremental SSG and many performance optimizations) ⚡
- Uses 2* data sources merged into one, unified API 📑
- Implements i18n 🌐
- Features strong focus on accessibility 👍
- Fully customizable 🛠️
- Pleasing, fully responsive design 💅
- Utilizes end-to-end encryption 🔒
- Written in TypeScript
*We aim to add more data sources in the future.
## Development
The following environmental variables need to be provided:
* `DB_URI` - MongoDB database URI.
* `DB_USER` - Database username.
* `DB_PASSWORD` - Database password.
* `DB_NAME` - Database name.
* `DB_COLLECTION` - Collection name.
* `NEXT_PUBLIC_AIRLY_KEY` - [Airly API](https://developer.airly.eu/) key.
* `NEXT_PUBLIC_WAQI_TOKEN` - [Air Quality Open Data Platform API](https://aqicn.org/api/) token.
* `NEXT_PUBLIC_MAPBOX_TOKEN` - [Mapbox](https://www.mapbox.com/) API token.
You can use the [`.env.local`](https://nextjs.org/docs/basic-features/environment-variables#loading-environment-variables) file for this.
---
> Hosted with [Vercel ▲](https://vercel.com)
```bash
# Run in development mode
$ npm run dev
# Build for production
$ npm run build
# Lint
$ npm test
```
## TODO
- [x] Home page
- [ ] Multiple data sources
- [x] Airly
- [x] World Air Quality Index
- [ ] ?
- [x] Show the amount of reports created
- [ ] Reports page
- [x] Map
- [ ] Charts
- [x] Sensor information
- [x] Provider
- [x] Location
- [x] Distance
- [x] Share functionality
- [x] Generate Open Graph images
- [x] Investigate the `Navigator.share()` API
- [x] Information about WHO standards
- [ ] Other pages
- [ ] Allow adding custom-made air pollution sensors
- [x] Manage locally created reports
- [x] Privacy policy
- [ ] i18n (long-standing task)
- [x] Persist global state (possibly blocked by Recoil API changes)
- [x] Secure API routes
- [ ] Improve language-based redirection
- [x] End-to-end encryption
## Technology stack
- [**React**](https://reactjs.org/) for UI;
- [**Next.js**](https://nextjs.org/) for SSG, dynamic routes and much more;
- [**Styled Components**](https://styled-components.com/) for styling;
- [**Recoil**](https://recoiljs.org/) for state management;
- [**MongoDB**](https://www.mongodb.com/) for storing user-generated reports.
### License
MIT