Skip to content

Latest commit

 

History

History
186 lines (137 loc) · 6.42 KB

README.md

File metadata and controls

186 lines (137 loc) · 6.42 KB
Raw

Adopt-a-Drain

Join the chat at https://gitter.im/sfbrigade/adopt-a-drain

Build Status Dependency Status Coverage Status

Claim responsibility for cleaning out a storm drain after it rains.

Screenshot

Adopt-a-Drain

Demo

You can see a running version of the application at http://adopt-a-drain.herokuapp.com/.

Docker (our prefered dev and test setup)

  1. To install Docker locally, pick your OS and follow steps here: Docker Store
  2. git clone this repository, and cd to it in your shell
  3. build the adopta image locally, this will take a few min 
    docker-compose build
  4. Setup your docker based postgres database (first time): 
    docker-compose run --rm web bundle exec rake db:schema:load
  5. Load data (first time): 
    docker-compose run --rm web bundle exec rake data:load_things
    OR: don't load all that data, and load the seed data (first time): 
    docker-compose run --rm web bundle exec rake db:seed
  6. Start the web server: 
    docker-compose up
  7. Visit your website http://localhost:3000 (or the IP of your docker-machine)

Installation without Docker

This application requires Postgres to be installed

git clone git://github.com/code4hr/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.

Usage

rails server

Seed Data

bundle exec rake data:load_drains

Deploying to Heroku

A successful deployment to Heroku requires a few setup steps:

  1. Generate a new secret token:

    rake secret

  2. Set the token on Heroku:

    heroku config:set SECRET_TOKEN=the_token_you_generated

  3. Precompile your assets

    RAILS_ENV=production bundle exec rake assets:precompile

git add public/assets

git commit -m "vendor compiled assets"

  4. Add a production database to config/database.yml

  5. 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.

Google Analytics

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 adoptadrain.org.

Contributing

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
  • [financially][]

[financially]:

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

  1. Fork the repository.
  2. Create a topic branch.
  3. Add specs for your unimplemented feature or bug fix.
  4. Run bundle exec rake test. If your specs pass, return to step 3.
  5. Implement your feature or bug fix.
  6. Run bundle exec rake test. If your specs fail, return to step 5.
  7. Run open coverage/index.html. If your changes are not completely covered by your tests, return to step 3.
  8. Add, commit, and push your changes.
  9. 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

Copyright (c) 2017 Code for Hampton Roads. See LICENSE.md for details.