TransitHealth

Help people explore data about public transit and public health across Chicago.

Directory Structure

transithealth
├── .github             Contains GitHub actions, automated tasks that runb after commits.
├── .pytest_cache       (Ignore, not committed) Stores information for Python unit test runs.
├── .venv               (Not committed) Details for your virtual environment.
├── api/                RESTful API server for the backend.
├── app/                Static React app for the frontend.
├── docs/               Documentation for the project.
├── notebooks/          Jupyter notebooks for each team member to do analysis and prototyping.
├── pipeline/           Offline pipeline for the backend.
├── .env                (Not committed) Specifies secret variables to use during development.
├── .gitattributes      Tells git how to process certain files in version control.
├── .gitignore          Tells git what files and folders not to commit.
├── LICENSE             Tells others the terms under which they can use this software.
├── Procfile            Tells Heroku how to run the server at deploy time.
├── pytest.ini          Settings for Python unit tests.
├── README.md           (This file!) Helps explain the project.
└── requirements.txt    Dependencies for Python modules and scripts.

View the App

• Production: scarletstudio.github.io/transithealth
• Staging: bit.ly/transithealth-staging
• Development: localhost:8001/transithealth

Getting Started

Follow the setup instructions.

Browse the project documentation.

Get Latest Version

To get the latest version of the main branch, run these commands:

git checkout main
git fetch
git pull

To merge the latest version of main into your branch, make sure all the work on your branch is committed, use the commands above to get the latest version of main, then run the commands below.

git checkout your_branch_name
git merge main

You may need to resolve merge conflicts. After a successful merge, you can continue development on your branch with the latest changes.

Build Data

Enter the pipeline/ directory, run this command to unpack the compressed database files, then return to the project root directory.

cd pipeline
make uncompressed
cd ..

Run Locally

To run the entire application locally, open two separate terminals for these two steps:

Terminal 1. Start Frontend

./app/dev.sh

Terminal 2. Start Backend

./api/dev.sh