Waterlevels

A website to display dam waterlevels in Cape Town's 6 major dams.

Original data is sourced from the Cape Town Open Data Portal, and is parsed and converted into an easily digestable JSON API .

Installation

1. Download the repository
2. bundle install

Usage via Docker

Run as a Docker container:

1. docker-compose build
2. docker-compose run web rake db:reset
3. docker-compose run web waterlevel:import
4. docker-compose up -d
5. visit localhost:3000
6. docker-compose down to kill the container

Note: run specs within the docker container: docker-compose run web rake spec

Usage via Foreman

Start Postgres and Rails with foreman start -f Procfile.dev

Usage alternate

Start Postgres

Start rails server bundle exec rails s - this will run an API server at http://localhost:3000

Start NPM development server - a browser window will open at http://localhost:8000

Import the latest data by running rake waterlevel:import.

Roadmap

• Nest API behind api/v1/ path
• Investigate automatic data imports

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

Waterlevels is released under the MIT License.