An open API service indexing awesome lists of open source software.

https://github.com/kurisubrooks/tfnsw-pids

Sydney Trains Passenger Information Display (PIDs)
https://github.com/kurisubrooks/tfnsw-pids

buses ferry light-rail metro open-data passenger-information-display passenger-information-system pids sydney sydney-trains trains

Last synced: 4 months ago
JSON representation

Sydney Trains Passenger Information Display (PIDs)

Awesome Lists containing this project

README

          

# TfNSW PIDs
Realistic recreation of Sydney Trains' PIDs using Transport for NSW APIs.



## Pre-requisites
- Node.js 14.0.0 (or later)
- CORS Proxy (self-hosted or other)

## Install
1. Run `git clone https://github.com/kurisubrooks/tfnsw-pids/` to download the files
2. Run `cd tfnsw-pids` to enter the directory
3. Run `yarn` or `npm install` to install dependencies
4. Edit `src/config.js` and add your proxy details

## Run
1. Run `yarn start` or `npm start`
2. Open [http://localhost:3000/pids](http://localhost:3000/pids) in a browser

## Config
#### Proxy (Required)
Fill the values in `src/config.js` with the details of your CORS proxy.

#### URL Params
Format: `url?key=value&key=value`
| Key | Default Value | Description |
| --- | --- | --- |
| `stop` | `200060` (Central Station) | Specify the station/platform ID |
| `theme` | `light` | Specify `dark` or `light` colour themes |

You can get the `stop` ID by searching for your station/light rail stop/bus stop/etc. from [AnyTrip](https://anytrip.com.au/).

URL Example:
http://localhost:3000/pids?stop=200060&theme=dark

### Credits
Made by [@kurisubrooks](https://kurisubrooks.com/)
Special Thanks to [Efren Palacios](https://efrenpalacios.dev/)

Transport for NSW data sourced from https://anytrip.com.au, with permission.