https://github.com/daveschumaker/local-air
View the latest air quality data from PurpleAir IoT sensors located near your home.
https://github.com/daveschumaker/local-air
air-quality air-quality-data air-quality-monitor aqi iot javascript pm25 purpleair
Last synced: 7 months ago
JSON representation
View the latest air quality data from PurpleAir IoT sensors located near your home.
- Host: GitHub
- URL: https://github.com/daveschumaker/local-air
- Owner: daveschumaker
- Created: 2020-08-25T02:34:32.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-23T16:10:21.000Z (almost 5 years ago)
- Last Synced: 2024-05-01T12:47:40.239Z (over 1 year ago)
- Topics: air-quality, air-quality-data, air-quality-monitor, aqi, iot, javascript, pm25, purpleair
- Language: JavaScript
- Homepage:
- Size: 227 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Local Air Quality Monitor
## Introduction
This simple Node app uses the PurpleAir API to display hyper-local air quality information based on PurpleAir IoT sensors located near where you live. You can check check the abundance of sensors near your place by visiting [https://www.purpleair.com/map?mylocation](https://www.purpleair.com/map?mylocation).
## Setup
The best way to start using this app is to clone the project into your local machine's project directory.
1. `cd ~/projects && git clone https://github.com/daveschumaker/local-air.git`
2. `cd local-air && npm install`
3. Rename `config-example.js` to `config.js` and enter appropriate details. You can find the ID for the PurpleAir sensor closest to your house by visiting the [PurpleAir map](https://www.purpleair.com/map?mylocation).
4. Run project using either `npm run dev` or `npm run build && npm run start`
5. View the node app's webpage in your browser by visiting `http://localhost:3000` (PORT 3000 is default, you can change this later)
## Contributions
If you're interested in contributing to the codebase, thank you!
Pull requests are the best way to propose changes and I welcome your pull requests:
1. Fork the repo and create your branch from `master`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints using the project rules.
6. Issue that pull request.
Note that any contributions you make will be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project.