/denver-marijuana-infographic

An infographic for Denver's marijuana data.

Primary LanguageJavaScriptMIT LicenseMIT

Denver Marijuana Data Visualization

##What is the Denver Marijuana Data Visualization?

A simple visual overview of marijuana data from the City and County of Denver. This project is based off of the Denver Data Visualization Template. To learn more about the project visit the template repo.

##Technical 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

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.

ETL Scripts

Rake tasks exist for each section of the data visualization. These tasks query the open data portal and update the csv files located in /data with the latest data. These can be set to run on a schedule through task scheduler (windows), a cron job (others), or heroku scheduler (heroku). Errors output to the console.

  • List all tasks: rake -T
  • Run all tasks: rake

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.

Feature Backlog

Issues and feature backlog are tracked through GitHub issues.

##License See the LICENSE for details.