README.md

Airqualityegg.com

The Air Quality Egg dashboard is a Ruby, Sinatra app that provides the web UI for the Air Quality Egg website.

Development

Prerequisites

• A working Ruby environment. The app should work in all common flavours of ruby (1.8.7, 1.9.2, 1.9.3, Rubinius, jruby)

Add environment variables to .env file

# Sample .env file
PRODUCT_ID=xxxxxx
API_KEY=xxxxxxx

The values in this file are required to interact with Xively, but some value for each environment variable is required to boot the app locally, so initially just create the file with dummy contents. Note that this means your local app won't be able to actually interact with Xively, but you will be able to view the AQE site running locally.

Install bundler gem

gem install bundler

Install all gem dependencies

bundle install

Start webserver

bundle exec foreman start

Visit http://localhost:5000, and you should see a version of the AQE website running locally on your machine.

Running the tests

bundle exec rake

Contributing

Please see our Contributing guidelines.

License

Please see LICENSE for licensing details.

Support

Please file any issues at our Github issues page. For general disussion about the project please go to the Air Quality Egg group.