🌳 🏃
JavaScript Other
Latest commit d83de63 Nov 19, 2015 @mateoclarke mateoclarke Update README.md
Permalink
Failed to load latest commit information.
data
img
js Revert "Extract unneeded HTML templates, JS, images, update README" Sep 24, 2015
sass
scripts
templates
.eslintrc
.gitignore
CNAME
CONTRIBUTING.md
README.md
UNLICENSE.md
config.json
package.json
webpack.config.js

README.md

Austin Parks Equity App

This is a civic app that aims to help visualize how Austin's park resources are distributed throughout the City of Austin.

Status: under development

Related News:

See our progress: Live Demo

Running Code Locally:

1. npm is required

npm is Node's package manager. You can install Node at their site or with a command like brew install node if you use Homebrew.

2. gulp is required

gulp is used to build and run the app. Before you can serve the app locally, you need to install gulp cli:

$ npm install -g gulp

3. webpack is required webpack is used to bundle assets

$ npm install -g webpack

To bundle assets:

$ webpack

4. install npm dependencies

Install the npm dependencies:

$ npm install

5. run the development server

To run the local server and see the app in your browser:

$ npm start

Serves the app at http://localhost:8080.

To (re)build data files:

The data processing workflow is (for the most part) automated with a Makefile in the data/ directory. This workflow assumes a UNIX operating system (such as OS X or Linux). You'll also need:

  • node / npm
  • ruby
  • ogr/gdal

To build data files, cd into the data/ directory:

$ cd data

And run make

$ make

If you want to rebuild or update a file, just delete it and re-run make. At the moment, not everything has been ported over to the Makefile, so this won't work for all files.

Data sources & use:

Architectural Decisions & Known Issues:

  • Our javascript files are messy. Based on the way this project grew from one map to many, we are currently making a separate js file for each html page. This is bad and should eventually be fixed.
  • For the park access heatmap, we ran a GIS process in ArcGIS. This static heatmap layer isn't response to park layers being toggled on and off. We'll probably use CartoDB to host these heatmaps in the future and rely on their PostGIS servers to create simplified buffers vs the cost-distance analysis heatmap we are currently working with.
  • Question about why or how we did something? Create an issue!

Credits

Unlicense:

Released to the public domain under the Unlicense by Open Austin, 2015.