The purpose of this project is to empower you to
- create your own copy of NYC Open Data
- create and share ETL workflows with the NYC civic tech community
- explore NYC Open Data and your ETL output with open source BI solutions
The project is a Ruby on Rails app with a Postgres database.
Each dataset is represented as an ActiveRecord model.
Create the database.
bundle exec rake db:create
Run migrations.
bundle exec rake db:migrate
Import a dataset.
DepartmentOfTransportation::BicycleCounter.import
You now have your own copy of the bicycle counter dataset!
The local setup guide provides instructions on how to run the rails app locally.
The core concepts document details the main technologies we are leveraging.
The nyc open data document explains how to pull datasets from the NYC Open Data Portal and into your own Postgres instance.
The etl document explains how to transform open data and store the results in your own Postgres instance.
The bi document explains how to use Apache Superset to explore your copy of NYC Open Data.
More bi solutions coming soon.
The production deployments document explains how to deploy the rails app to Heroku.
More platforms coming soon.
TLDR:
- Fork the repository
- Create a branch
- Make your changes
- Submit a pull request
The contributing document provides more information.