8000 GitHub - iRail/iRail: iRail API / scraper · GitHub
[go: up one dir, main page]

Skip to content
iRailPublic

About

iRail API / scraper

Topics

Resources

Contributing

Stars

139 stars

Watchers

8 watching

Forks

Latest commit

 

History

2,518 Commits

Folders and files

Repository files navigation

iRail

License AGPL-3.0 Join the chat at https://gitter.im/iRail/iRail

iRail supports digital creativity concerning mobility in Belgium. This is an attempt to make the railway time schedules in Belgium easily available for anyone.

Our main site consists of a very easy mobile website to look up time schedules using our own API.

Native applications using the iRail API and created or supported by the iRail team are named BeTrains and RailerApp.

API Documentation

API Documentation can be found at https://docs.irail.be.

Installation for development purposes

  • Step 1: Clone this repo
  • Step 2: Set environment variables
    • nmbs_riv_key should contain a valid API key for the internal NMBS RIV API.
    • spring_datasource_url, spring_datasource_username and spring_datasource_password should point to a PostgreSQL database.
  • Step 4: Run the docker container
  • Step 5: Enjoy your own iRail API at http://localhost:8080/.

Caching and performance

iRail caches large amounts of data in memory. At least 2GB RAM is required. When using the docker image, use the JAVA_TOOL_OPTIONS environment variable to set memory flags, for example -Xms1200M -Xmx1700M.

GTFS calendar dates are filtered during ingestion using gtfs.static.range.back and gtfs.static.range.forward, in days, including both boundary dates. These settings default to 2 days in the past and 62 days in the future. Trips and stop times without service in this window are excluded from the internal model.

Update stations list

Stations are stored in the stations database table. They can be filled with data from the provided SQL file. A complete list of stations can be found in the irail/stations repository.

More links

About

iRail API / scraper

Topics

Resources

Contributing

Stars

139 stars

Watchers

8 watching

Forks

Releases

Used by

Contributors

Languages

0