Giter Club home page Giter Club logo

sfbrigade / adopt-a-drain Goto Github PK

View Code? Open in Web Editor NEW
44.0 17.0 57.0 8.55 MB

A web application that allows citizens to "adopt" a storm drain in San Francisco. In use, and in development at other brigades. Looking for a maintainer or someone interested in developing further in collaboration with others across the country.

Home Page: http://adoptadrain.sfwater.org/

License: BSD 3-Clause "New" or "Revised" License

Ruby 54.65% JavaScript 17.84% HTML 7.38% CSS 3.55% Dockerfile 0.11% Procfile 0.02% Haml 16.46%
ruby docker full-stack-developer environment civic-infrastructure stable code-for-america code-for-sf

adopt-a-drain's Introduction

Adopt-a-Drain

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

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

⚠️⚠️⚠️⚠️⚠️⚠️⚠️

This repository no longer reflects the official San Francisco Adopt-a-Drain website, which is now maintained by Civic Hub.

⚠️⚠️⚠️⚠️⚠️⚠️⚠️

Screenshot

Adopt-a-Drain

Installation

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.

Docker

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)

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

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][travis] 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) 2015 Code for San Francisco. See LICENSE.md for details.

adopt-a-drain's People

Contributors

24glinka avatar afomi avatar bensheldon avatar danmelton avatar dependabot-preview[bot] avatar dependabot-support avatar dependabot[bot] avatar drkk avatar dsummersl avatar equiamos avatar evanhahn avatar gitter-badger avatar howdoicomputer avatar jasnow avatar jasonlally avatar jszwedko avatar kmacedo avatar kmcurry avatar kylefantastic avatar mick avatar mlevans avatar monfresh avatar ralam avatar ralreegorganon avatar raudabaugh avatar sferik avatar softwaresteph avatar squidarth avatar therebelrobot avatar tonyta avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

adopt-a-drain's Issues

If drains aren't adoptable, say why

For example, if the SFPUC or another org owns/manages a drain, that drain should be claimed (either manually or permanently or something) by that org. Convey that clearly to the public when wanting to adopt a drain.

Clean up and modernize UI scaffolding - bootstrap 2 -> 3

I was looking at the UI scaffolding used to layout the map and sidebar and it's simple enough, but uses table and table-cell layouts in a manner that makes it hard to make this friendly on mobile.

Without knowing the exact direction yet, it's simple enough to modernize the layout so it's a bit more flexible and mobile-friendly and uses Bootstrap 3 and it's dependencies.

This is just house cleaning to clear the way for more robust UI and UX changes.

Make app accessible

Have James Tyack go through it. Idk his github, but he's often at hacknight. I'm sure he'd be game to go through this and/or make suggestions for things we can look out for.

Support small screens

Need: on mobile, the sidebar is difficult to use. Can we redesign to make it easier on mobile?

Open Data API Integration

cc: @sfbrigade/website-tools-core-team

So I was chatting with @jasonlally about the API that will be released soon for the drains (soonest tomorrow, latest end of this week), and he directed me to a currently published API that has a similar structure: http://dev.socrata.com/foundry/#/data.sfgov.org/cuks-n6tp

We'll want to see where in the app the api is being consumed, and see what will be needed to tie it into the new API.

Once [the API is public], you can grab a geojson feed of the points OR grab the csv or json with lat and long as fields...

... So you can expect a coordinate pair, the weird thing is geojson flips lat and long
Otherwise it's standard among any other geojson structure

Post-storm email thanking folks for cleaning their drains

V1: Thank people and say that we had X# new adoptions as a result of the app
V2 (post user confirmation they cleaned their drain): Thank people and share how many people cleaned their drains
VN (once we have data from DPW? on how much less flooding occurred during the most recent event when compared to other similar events w/out adoptadrain): Thank people, share how many people cleaned their drains, and share how much less flooding there was and cost savings as a result.

Tweet out when someone new adopts a drain

[] Ask user for twitter handle
[] Tweet from the PUC handle 30 minutes after the adoption happens (so the user has time to name the drain).
[] Use this copy: TBD

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.