https://github.com/mbta/commuter_rail_boarding

Parser/Uploader for Keolis Commuter Rail train information
https://github.com/mbta/commuter_rail_boarding

Last synced: about 1 month ago
JSON representation

Parser/Uploader for Keolis Commuter Rail train information

• Host: GitHub
• URL: https://github.com/mbta/commuter_rail_boarding
• Owner: mbta
• License: mit
• Created: 2017-08-01T19:25:33.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-10-12T05:19:22.000Z (about 1 year ago)
• Last Synced: 2023-10-14T20:12:24.693Z (about 1 year ago)
• Language: Elixir
• Homepage:
• Size: 1.02 MB
• Stars: 3
• Watchers: 11
• Forks: 2
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# CommuterRailBoarding / TrainLoc

There are two applications which are a part of this repository, and run together in AWS.

- CommuterRailBoarding: uploads the Commuter Rail boarding status information

  to an Enhanced TripUpdates JSON file.

- TrainLoc: uploads the train locations to an Enhanced VehiclePositions JSON

  file. It also tracks conflicts where multiple vehicles are logged into the

  same trip.

## Installation/Running

```shell

$ mix deps.get

...

$ export V3_API_KEY=[key from https://api-v3.mbta.com]

$ mix test # V3_API_KEY is required to avoid rate limits

$ export GCS_CREDENTIAL_JSON=[JSON data for Firebase token]

$ export CRB_FIREBASE_URL=[path to departureData Firebase feed]

$ export TRAIN_LOC_FIREBASE_URL=[path to AVLData_from_VehicleLocation Firebase feed]

$ mix run --no-halt

```

## System architecture

See [ARCHITECTURE.md](./ARCHITECTURE.md) for more information on how

CommuterRailBoarding and TrainLoc work internally.