Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 739 Bytes

README.md

File metadata and controls

15 lines (11 loc) · 739 Bytes

TrainBoard

Welcome to the TrainBoard repo.

Getting started

You will need a TfNSW API key to be able to query train data from the API. You can obtain one for free at the OpenData Transport NSW site. You can then enter this key in the app settings once it's up and running.

It will need access to the following APIs:

  • Trip Planner APIs - required
    • To show the list of departing trips
  • Public Transport - Realtime Vehicle Positions - optional
    • To show vehicle positions with Google Maps

Because the TfNSW API doesn't support CORS requests, we need to use a proxy server.

You can either use a local proxy server, or a CloudFlare worker. See the proxy folder for more details.