Skip to content

Latest commit

 

History

History
87 lines (54 loc) · 3.35 KB

README.md

File metadata and controls

87 lines (54 loc) · 3.35 KB

Denver Street Sweeping Client

Build Status

Current Status: As of October 2014 Denver Street Sweeping is available on http://streetsweep.co/ as a pilot project for the City and County of Denver.

This is the repo for Denver Street Sweeping's client code. If you're looking for the backend API code, visit this repo.

##What Is Denver Street Sweeping?

Denver Street Sweeping is a web application developed by the 2014 Code for America Fellows in Denver. The app uses street sweeping data from the City and County of Denver. It allows residents of Denver to lookup an address and find the corresponding street sweeping schedule for that address. The resident can then sign up for schedule reminders by Email or SMS. The web app is responsive.

Read more about Denver Street Sweeping here

##Technical Details

The Denver Street Sweeping client reads and parses data from the API and presents it on screen.

Languages: Javascript, HTML, CSS

Platform pieces

Libraries

  • jQuery is a Javascript library.
  • Font Awesome 4.0.3 is used to render many of the icons on the site.
  • handlebars is used to format and represent data from the API on the front end.

Code

Denver Street Sweeping is composed of an API backend and a client front end. The API reads the data. The front end takes data from the API, formats it, and serves up the website. A commit to master triggers a build, tests, and deployment to the staging server. Production is hosted on github pages and can be manually deployed with a push to gh-pages branch.

Installation, Usage

Use python's simple server to run the code:

python -m SimpleHTTPServer 8000

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.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a topic branch.
  3. Submit a pull request.

##License See the LICENSE for details.