NS Reisplanner

This application shows real time train arrivals and departures using data provided by De Nederlandse Spoorwegen.

Prerequisites

• PHP (7.4 or higher)
• Composer
• GNU Make
• Docker
• Docker Compose

Getting started

Dependencies

Run make to install all necessary dependencies and compile the assets.

You will also need an API key from the NS Travel information API and add it to the .env (or create a .env.local) file in the root of this project.

Environment

Use docker-compose up to get the application up and running. Then execute the database migrations:

docker-compose exec app bin/console doctrine:migrations:migrate

Importing train stations

In order to import all available train stations the following command can be executed.

docker-compose exec app bin/console ns-reisplanner:import-stations

Importing disruptions

In order to import and update the actual disruptions the following command can be executed.

docker-compose exec app bin/console ns-reisplanner:import-disruptions

View the application

The application can be reached locally by opening http://localhost/departures-and-arrivals link

Running the tests

Run make test to execute all available tests. There are also more fine-grained targets, such as make unit-tests for only running unit tests. See the Makefile for all available targets.