#SFTMA Data Analysis

1️⃣ You can find the deployed project at https://master.d3j9ctmbednoov.amplifyapp.com/
You can find the staging server at https://staging.d3j9ctmbednoov.amplifyapp.com/

4️⃣ Contributors

Justin Kuenzinger	Nick Migel	Bairon Paz	Justin Russell	Kevin Phillips

Cody Holman	Connor Angelis	Jonathan Allison	Michelle Sirimanivong	Erik Sandoval

Project Overview

1️⃣ Trello Board

1️⃣ Product Canvas

1️⃣ UX Design files

4️⃣ Key Features

Have a publically available database of historical data on SFMT vehicles.
Analysis of bunching and gapping on bus and rail lines.
Generate daily reports for each type of transit system, and reports for specific routes.

1️⃣ Tech Stack

Front end built using:

React, mapbox, chartjs, react-calendar

Front end framework goes here

React

Easy to create a new app with pre-installed dependencies with Create React App.
Able to use React compatible libraries for styling and functionality.
Easy to use

Front end deployed to AWS

APIs

3️⃣ https://sfmta-test.herokuapp.com/type-map?type=${type}

Flask App API that returns data on traces, layout and names for SFMTA routes.

3️⃣ https://sfmta-test.herokuapp.com/routes-info

Flask App API that returns data on route id, route name and type of route.

3️⃣ https://sfmta-test.herokuapp.com/real-time?id=${realTime}

Flask App API that returns real time data with vehicle ID and vehicle direction for each vehicle on a speficied route.

3️⃣ Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

REACT_APP_MAPBOX_TOKEN = pk.eyJ1Ijoic2ZtdGFsYW1iZGEiLCJhIjoiY2thc2ppM2RtMWo4NzJxcDE1MDB3MWNieiJ9.M5tx0lpksjJp3OY4BXkyow

5️⃣ Content Licenses

Image Filename	Source / Creator	License
favicon.ico	Favicon.io	Favicon
apple-touch-icon.png	Favicon.io	Favicon
logo.png	Icons8	Icons8
trolley.jpg	Unsplash	Unsplash
city.jpg	Unsplash	Unsplash
cody.jpg	Cody Holman	Creative Commons
agustin.jpg	Agustin Vargas	Creative Commons
connor.jpg	Connor Angelis	Creative Commons
erik.jpg	Erik Sandoval	Creative Commons
jonathan.jpg	Jonathan Allison	Creative Commons
jordan.jpg	Jordan Ireland	Creative Commons
justin.jpg	Justin Menendez	Creative Commons
mathias.jpg	Mathias Skreden	Creative Commons
michelle.jpg	Michelle Sirimanivong	Creative Commons

4️⃣ Testing

Jest and react testing library

4️⃣ Installation Instructions

Install dependencies with npm install

Other Scripts

* start - starts the production server after dependencies are installed
* test - runs tests in **tests** directory
* eject - copy the configuration files and dependencies into the project so you have full control over them

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

Check first to see if your issue has already been reported.
Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
Create a live example of the problem.
Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

Ensure any install or build dependencies are removed before the end of the layer when doing a build.
Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
Ensure that your code conforms to our existing code conventions and test coverage.
Include the relevant issue number, if applicable.
You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Data Science Documentation (https://github.com/Lambda-School-Labs/sfmta-data-analysis-ds) for details on the backend of our project.

BloomTech-Labs/sfmta-data-analysis-fe