A citywide dashboard with ward-by-ward views of service delivery in Chicago. Includes complete API. Built using Chicago Open311 data.
JavaScript Go CSS Python Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
bin
config
db
doc
frontend
.gitignore
Capfile
Gemfile
Gemfile.lock
LICENSE.md
Makefile
README.md

README.md

Chicago Works For You

CWFY screenshot

Chicago Works For You (http://www.chicagoworksforyou.com) is a citywide dashboard with ward-by-ward views of service delivery in Chicago.

Technical

The CWFY website (frontend/) runs on Jekyll and Compass. There is a backend API (api/) written in Go.

See API.md for details on how to use the backend API. See FRONTEND.md for information on the public-facing website.

Data

The service request data for Chicago Works For You comes from the City of Chicago Open311 API.

Chicago Works For You publishes a nightly database snapshot. This is a complete copy of the production database powering chicagoworksforyou.com.

Download the snapshot

Instructions for loading into a local PostgreSQL database:

createdb cwfy
pg_restore -d cwfy -O -c /path/to/download/production.dump

This assumes that your have PostgreSQL installed and the PostGIS extension installed. If you are using Mac OS X, Postgres.app is a very quick and easy way to install both PostgreSQL and PostGIS. The database schema is available at db/schema.sql.

Contributing

We welcome contributions to the application. A few guidelines:

  • Fork this repository
  • Create a topic branch
  • Open a pull request with a concise description of the change. Bonus points for a screenshot.

License

The application code is released under the MIT License. Editorial content is released under the Creative Commons Attribution 3.0 Unported (CC BY 3.0) license. Content from other authors (e.g. photos on service types pages) are used according to their licenses.

Credits

CWFY was built by Daniel X. O'Neil, Sandor Weisz, and Chris Gansen.

We thank Christopher Whitaker, Q Ethan McCallum, Rob Brackett, Eryan Cobham, and Paul Smith for valuable contributions and feedback.