Hack Oregon - Urban Development project

README

Purpose

This project is creating a data visualization tool, so that users can tell their own stories about urban change.

Technology

The web site, PlotPDX, is a Single-Page Application (SPA), implemented in JavaScript. The application running in a web browser accesses data from RESTful web services. See the urbandev-backend source repository for information about the urbandev-backend web services.

The browser application is based on the BootLeaf template. It uses several JavaScript frameworks:

• leaflet: "an open-source JavaScript library for mobile-friendly interactive maps."
• leaflet-groupedlayercontrol: "Leaflet layer control with support for grouping overlays together."
• taffy: "The JavaScript Database ... that brings database features into your JavaScript applications."
• moment: "Parse, validate, manipulate, and display dates in JavaScript."
• daterangepicker: "A JavaScript component for choosing date ranges. Designed to work with the Bootstrap CSS framework."

To view the deployed application

Navigate to the web site, http://www.plotpdx.com/prototype/

To build the application

Clone this repository and then from the top-level dirctory, use npm to get dependencies:

npm install

Run grunt to assemble the application files:

grunt

Open index.html in a browser to run the application. You should see a map of Portland, Oregon. There are also controls for selecting neighborhoods, types of data to display, and time periods. The web application is running in the browser on your local machine, but it queries web services to retrieve data about activities in Portland neighborhoods. The application only displays information for the city of Portland, Oregon in the United States.

To contribute to the project

Contact Hack Oregon if you would like to work on this project. If you are already working on this project, please follow the "Getting started as a contributor" guidelines for submitting code.

Project history

This repository was created during the Fall 2015 season of Hack Oregon. There had been some prior work on the PlotPDX project, but the urbandev-frontend repository where you are now is the latest work on this project.