Git Product home page Git Product logo

local-air's Introduction

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.

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.
  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 that covers the project.

local-air's People

Contributors

daveschumaker avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

lemonkey

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.