https://github.com/samleatherdale/trainboard

Show Sydney Trains trip information in a large screen format.
https://github.com/samleatherdale/trainboard

Last synced: about 10 hours ago
JSON representation

Show Sydney Trains trip information in a large screen format.

• Host: GitHub
• URL: https://github.com/samleatherdale/trainboard
• Owner: SamLeatherdale
• Created: 2020-02-02T02:46:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T10:40:15.000Z (6 months ago)
• Last Synced: 2024-04-05T11:38:54.383Z (6 months ago)
• Language: TypeScript
• Homepage: https://trainboard.samleatherdale.com
• Size: 796 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://opendata.transport.nsw.gov.au/). 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.