/denver-data-visualization-template

A starting point for any infographic for the city and county of Denver.

Primary LanguageJavaScriptMIT LicenseMIT

Denver Data Visualization Template

##What is the Denver Data Visualization Template?

The Denver Data Visualization Template is a starting point for anyone to create rich, interactive, and visual dashboards using open data. The template created by the 2014 Code for America Fellows for the City and County of Denver. So far the template has been used to create the following visualizations:

Read more about the Denver Data Visualization Template here

##Technical Details

This is the starting point for Denver visualizations. It unifies the look and feel of the sites. All visualizations share the same stack, built on top of jekyll. ETL scripts update the data from Denver's open data portal. See the readme for each repo for additional details.

Languages: Javascript, HTML, CSS, Ruby (ETL scripts)

Platform pieces

  • jekyll is a static site generator.
  • D3 is the charting library we use to generate visualizations
  • SASS is used for managing CSS variables.
  • jQuery is used for handling navigation and chart responsivity.
  • Bootstrap 3.1.1 is used as the frontend HTML/CSS/JS framework.

Libraries

  • dimple is a D3 plugin that makes it easier to generate and style charts
  • handlebars is templating library.
  • Rake is used to run the ETL scripts.

Prerequisites

Code

See the readmes for other visualization repos for specific deployment details.

Installation, Usage

Download dependencies in the command line: bundle

Local Development

  1. Jekyll compiles everything into a static site in the _site folder. In order to get the latest changes and start the server, use the following command: jekyll serve --watch
  2. Navigate to localhost:4000 to preview the site. Most changes will update immediately. The exception is changes to _config.yml. The server will need to be restarted in that case.

Deployment

  1. Compile the site: jekyll build
  2. Deploy contents of /_site to server.

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. [license]: https://github.com/boonrs/denver-infographic-template/blob/master/LICENSE