Source for the EnergySparks website
Clone or download
Latest commit 9acaed9 Dec 12, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ebextensions Merge pull request #403 from BathHacked/environment-automated-email-g… Nov 30, 2018
.elasticbeanstalk Set default deployment branches for environments Nov 23, 2018
app Merge pull request #422 from BathHacked/experimenting-with-zoomable Dec 12, 2018
bin Update to use tmp directory to get and push files Nov 13, 2018
config Check for years worth of validated readings before enabling analysis Dec 5, 2018
db Remove school dataset atrtibutes Nov 28, 2018
etc Add default Sheffield calendar and after party task to populate it Nov 23, 2018
lib Merge branch 'historical-sheffield-gas-config' into refactor-csv-impo… Dec 5, 2018
log Empty rails project Aug 31, 2016
markdown_pages/help add route, controller method, helper method to render help pages (.md) Oct 25, 2016
public Link to /public error page assets Dec 5, 2018
script Add this script May 24, 2018
spec Merge remote-tracking branch 'origin/master' into review-authorisation Dec 6, 2018
vendor/assets Merge branch 'date-picker-changes' into simulator-part-1 Jul 18, 2018
.gitignore No longer ignore the elasticbeanstalk config directory Nov 23, 2018
.jshintrc Tweak JS and lint Jun 25, 2018
.overcommit.yml Use update flag for bundle-audit Nov 8, 2018
.rspec add authentication, authorization, bootstrap, annotation of models Oct 9, 2016
.rubocop.yml Bump size of connection pool and fix some rubocop grumbles Oct 19, 2018
.ruby-version Updated ruby for latest AWS platform Nov 18, 2018
.travis.yml Revert travis deploy Nov 9, 2018
CONTRIBUTING.md Add initial contributor guidelines, borrowing from https://github.com… Aug 31, 2016
Capfile Remove scripts and automation for socrata Nov 28, 2018
Gemfile Upgrade to Rails 5.2.2 Dec 5, 2018
Gemfile.lock Upgrade to Rails 5.2.2 Dec 5, 2018
LICENSE Initial commit Aug 16, 2016
README.md tmp Oct 18, 2018
Rakefile Empty rails project Aug 31, 2016
config.ru Take out profile stuff Jun 15, 2018
reset-development-database-and-populate-dev-data.sh Allow group edit and calendar edit for school May 16, 2018
sample-data.csv refactor meters Oct 11, 2016

README.md

Build Status Maintainability Test Coverage

Energy Sparks

Energy Sparks is an open source application that is designed to help schools improve their energy efficiency.

The application collects and presents gas and electricity usage data in a way that is accessible to staff, students and parents. Supported by educational resources, the application will support teachers in helping children understand more about energy usage, how to be more efficient and see how actions they take in the school, e.g. switching off lighting, has an effect on usage.

Combining access to data, the ability to log interventions and a competitive element between schools, the goal is to not just save schools money in reducing energy consumption through long term changes, it is hoped that the application will also help educate children about what it means to be energy efficient.

The application is open source and is powered by open data. It is being designed to be easily deploy and run for minimal cost, allowing it to be run by local councils and/or community groups around the UK.

The initial prototype application and user testing is being carried out in Bath & North East Somerset. The work is a joint project between Bath: Hacked, Transition Bath, Resource Futures and B&NES council.

The project has been funded by an award from the Open Data Institute summer showcase 2016.

For Users

Development of the application and documentation is in progress. Please check back later for more information.

For now you may wish to read the evolving documentation in the project wiki.

For Developers

The application is a Rails 5.2, Ruby 2.5.1 project.

Read the CONTRIBUTING.md guidelines for how to get started.

Extra notes

Development mode uses mail catcher for sending mails - you need to install the mailcatcher gem for this to work correctly.

Setting up a new test environment

  1. Set up appropriate database in RDS - make sure the password doesn't have any (or too many) special characters, best to keep to digits and letters if possible!
  2. Use pg_dump to get dump of current production database
  3. Use psql to get data into new database
  4. Clone production environment
  5. Update environment variables to point at new database, plus the various other test things like rollbar
  6. add the EC2 security group for the new machine to the RDS security section