Giter Club home page Giter Club logo

atd-data-and-performance's Introduction

Austin Transportation Data and Performance Hub

This repository houses the City of Austin Transportation Department's Data and Performance Hub, a public website which tracks the department's operational performance and curates access to key datasets.

This site is hosted at data.mobility.austin.gov and uses Jekyll, Webpack and Netlify to create static pages.

Much of the content on the site is generated in-browser using D3js, jQuery, and React to visualize data from the City of Austin Open Data Portal.

Quick Start

  1. Install Git and Jekyll.

    • You may need to install Bundler v2. Do that with the command gem install bundler then bundle install to update your gems. Go here for more info.
  2. cd to the directory where you want to check-out the site, and clone it (git clone https://github.com/cityofaustin/atd-data-and-performance)

  3. cd to the directory that contains the cloned repository, and run jekyll serve to start the webserver

  4. Navigate to http://localhost:4000 in your browser to view the site hosted-locally

Optional Advanced Javascript

If you will be working on any data dashboards that utilize Javascript ES6+ and/or React.js, we have a build setup for transpiling modern JS into a cross-compatible bundle.

  1. run npm install to download and install javascript dependencies from package.json

  2. run webpack --watch. As files are modified, a new bundle will be automatically generated.

  3. (optional) Inspect webpack.config.js and create a new entry to start a new bundle.

TL;DR

  1. run jekyll serve --watch in one Terminal
  2. run webpack --watch in a separate Terminal

Webpack will watch for changes to your source javascript/react files and output a new bundle. Jekyll will watch for new bundles and regenerate all the static assets.

Environments

Production

  • URL: transportation.austintexas.io

  • GitHub Branch: master

  • Deployment: Commit changes to branch test and submit a pull request to merge to master

Contributing

Public contributions are welcome! Assign pull requests to @johnclary.

License

As a work of the City of Austin, this project is in the public domain within the United States.

Additionally, we waive copyright and related rights of the work worldwide through the CC0 1.0 Universal public domain dedication.

atd-data-and-performance's People

Contributors

tillyw avatar johnclary avatar amenity avatar dependabot[bot] avatar chiaberry avatar sergiogcx avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.