Skip to content

Latest commit

 

History

History
133 lines (100 loc) · 4.95 KB

README.mkd

File metadata and controls

133 lines (100 loc) · 4.95 KB
Raw

OpenBlight

A dashboard for the city of New Orlean's Code Enforecement process

Build Status

Build Status

Dependency Status

Dependency Status

Demo

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

Installation

Instructions for Ubuntu 12.04 Precise Pangolin (LTS)

Instructions for Mac OS X 10.6 Snow Leopard

git clone git://github.com/codeforamerica/openblight.git
cd openblight
bundle install
rake db:migrate

Usage

rails server

Deploying to Heroku

This application has some particular challenges when deploying to Heroku.

  1. You need to have a Postgis-enabled database
  2. Taps doesn't recognize the Postgis adapter type. In order to use taps, you have to change the adapter in your database.yml file to postgres. You also need to temporarily change the database URL to postgres://path-to-your-database via heroku config
  3. If you push or pull a database using taps, your spacial column types will not be saved. Go into rails or heroku pg:psql and run:

ALTER TABLE addresses ALTER point TYPE Geometry USING ST_GeomFromText(point); ALTER TABLE streets ALTER the_geom TYPE Geometry USING ST_GeomFromText(the_geom);

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. You can indicate support for an existing issue by voting it up. 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 project.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add tests for your feature or bug fix.
  5. Run bundle exec rake test. If your changes are not 100% covered, go back to step 4.
  6. Commit and push your changes.
  7. Submit a pull request. Please do not include changes to the gemspec or version file. (If you want to create your own version for some reason, please do so in a separate commit.)

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

If something doesn't work on one of these interpreters, 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 versions listed 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) 2012 Code for America. See LICENSE for details.

Code for America Tracker