README.md

Documentation

Welcome to the documentation for TransitHealth!

Most Used

The most frequently-used documentation pages.

• Common Commands
• Common Tasks

First Time

Guides to help you get started using and contributing to the project.

• Project Overview (Slides)
• Setup Instructions

Codebase Overviews

Guides to explain the layout of the codebase and common commands for working with each system.

• System Overview (Video)
• Frontend App
• Backend API
• Offline Pipeline

Guides By Schedule

• Week 1
  • Add a New Dataset
  • Add a New Endpoint
• Week 2
  • Exploratory Data Analysis
  • Add a New Question
• Week 3
  • Coming soon...
• Week 4
  • Coming soon...

Guides By Topic

General Software Engineering Topics

• Using Git
• Merge Conflicts
• Testing
• Exploratory Data Analysis (Coming Soon)

Project-Specific Topics

Frontend

• Add a New Question
• React (Coming Soon)
• Recharts (Coming Soon)
• Accessibility (Coming Soon)
• Table Component (Coming Soon)

Backend

• Add a New Endpoint
• RESTful API Concepts
• Flask
• Write SQL Queries
• Inspect API Requests
• Time API Requests

Pipeline

• Add a New Dataset
• Extract, Transform, and Load (ETL)
• Makefiles
• Socrata Query Language (SoQL)
• Create SQLite Tables
• SQLite Command Line Interface
• Common Data Transformations
• Argparse

Tools

• Cloud9
• Jupyter Notebooks
• Cypress

Deployment

• Run Staging