Claim responsibility for cleaning out a storm drain after it rains.
You can see a running version of the application at http://adopt-a-drain.herokuapp.com/.
This application requires Postgres to be installed
git clone git://github.com/sfbrigade/adopt-a-drain.git cd adopt-a-drain bundle install bundle exec rake db:create bundle exec rake db:schema:load
See the wiki for a guide on how to install this application on Windows.
To setup a local development environment with Docker.
# Override database settings as the docker host: echo DB_HOST=db > .env echo DB_USER=postgres >> .env # Setup your docker based postgres database: docker-compose run --rm web bundle exec rake db:setup # Load data: docker-compose run --rm web bundle exec rake data:load_things # OR: don't load all that data, and load the seed data: # docker-compose run --rm web bundle exec rake db:seed # Start the web server: docker-compose up # Visit your website http://localhost:3000 (or the IP of your docker-machine)
bundle exec rake data:load_drains
Deploying to Heroku
A successful deployment to Heroku requires a few setup steps:
Generate a new secret token:
Set the token on Heroku:
heroku config:set SECRET_TOKEN=the_token_you_generated
RAILS_ENV=production bundle exec rake assets:precompile git add public/assets git commit -m "vendor compiled assets"
Add a production database to config/database.yml
Seed the production db:
heroku run bundle exec rake db:seed
Keep in mind that the Heroku free Postgres plan only allows up to 10,000 rows, so if your city has more than 10,000 fire drains (or other thing to be adopted), you will need to upgrade to the $9/month plan.
If you have a Google Analytics account you want to use to track visits to your deployment of this app, just set your ID and your domain name as environment variables:
heroku config:set GOOGLE_ANALYTICS_ID=your_id heroku config:set GOOGLE_ANALYTICS_DOMAIN=your_domain_name
An example ID is
UA-12345678-9, and an example domain is
In the spirit of free software, everyone is encouraged to help improve this project.
Here are some ways you can contribute:
- by using alpha, beta, and prerelease versions
- by reporting bugs
- by suggesting new features
- by translating to a new language
- by writing or editing documentation
- by writing specifications
- by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
- by refactoring code
- by closing issues
- by reviewing patches
Submitting an Issue
We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.
Submitting a Pull Request
- Fork the repository.
- Create a topic branch.
- Add specs for your unimplemented feature or bug fix.
bundle exec rake test. If your specs pass, return to step 3.
- Implement your feature or bug fix.
bundle exec rake test. If your specs fail, return to step 5.
open coverage/index.html. If your changes are not completely covered by your tests, return to step 3.
- Add, commit, and push your changes.
- Submit a pull request.
Supported Ruby Version
This library aims to support and is tested against Ruby version 2.2.2.
If something doesn't work on this version, it should be considered a bug.
This library may inadvertently work (or seem to work) on other Ruby implementations, however support will only be provided for the version above.
If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be personally responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.
Copyright (c) 2015 Code for San Francisco. See LICENSE.md for details.