LPP Bus visualisation

1. Preparation

1.1 Requesting daily timetables and other LPP data

Before you can use the visualisation, you need to request some timetable and station data from the LPP API. To do this, you need to run the "recording" server inside preparation. You'll need Rust for this.

The steps are as follows:

Copy preparation/data/configuration.TEMPLATE.toml to preparation/data/configuration.toml and fill out any required fields.
Build the project in release mode: run cargo build --release inside the preparation directory.
To download data for the current day, run cargo run --release -- --run-mode once and wait for completion. This might take around half an hour or maybe up to an hour - you can monitor the current progress by looking at the current_station and total_stations fields in the logs. For any other available options, see cargo run --release -- --help. At the very end you may see quite a few "errors" in the console - this is normal, the program just displays warning and/or errors when encountering abandoned or invalid bus lines and stations. They will simply be filtered out of the output files.
After the program exits successfully, you'll find the "recordings" in the configured output directory. Copy the route-details-* and station-details-* bare files to visualization/public/data (create the directory if needed).

1.2 Download required assets

Download the Roboto font from here into the visualization/public/fonts/Roboto directory (the file visualization/public/fonts/Roboto/Roboto-Regular.ttf should now exist, among others).

1.3 Configure the available data files and map API keys

Inside the visualization/src directory, copy the data.TEMPLATE.ts to data.ts and fill out the filenames of the available data files. If, for example, you have the file visualization/public/data/route-details_2023-11-05_19-11-53.567+UTC.json, add route-details_2023-11-05_19-11-53.567+UTC.json to the allRouteSnapshots array in the file. Do the same for station files.

Inside the visuzalization/src directory, copy the secrets.TEMPLATE.ts to secrets.ts and fill out the required fields. You can get the API key for the Ljubljana map by signing up over at JawgMaps and getting your access token here.

1.2 Building the visualization

You're now ready to build the visualization. You'll need Node 18+ and Yarn.