Git Product home page Git Product logo

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.

All information can be found on our blog at hello.iRail.be.

API Documentation

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

Installation for development purposes

note: you'll also need to have nodejs, composer and the PHP extensions listed in composer.json installed on your system

  • Step 1: Clone this repo
  • Step 2: Create an .env file which will contain your configuration.
  • CACHE_DRIVER should be set to apc, an in-memory cache with good performance.
  • NMBS_RIV_API_KEY should contain a valid API key for the internal NMBS RIV API.
  • GTFS_RANGE_DAYS_BACKWARDS and GTFS_RANGE_DAYS_FORWARDS define how long in the past and future GTFS data will be
  • APP_TIMEZONE should be set to EUROPE/BRUSSELS to ensure correct times in the responses, since several date/times without timezone information are parsed and interpreted at this timezone. read. This will affect memory usage, and limits the date ranges of some API endpoints.
  • Step 4: Run the docker-compose configuration, which consists of nginx, mariadb and the actual PHP application. If you want to use sqlite, adjust the database configuration. Note that sqlite is untested.
  • Step 5: When using mariadb, ensure a database exists on the mariadb server. It should match the database credentials specified for the php application in the docker-compose file.
  • Step 6: Run the database migrations in order to create the necessary database tables: php artisan migrate
  • Step 7: Enjoy your own iRail API at http://localhost:8080/. All routes are defined in the routes file. See the laravel docs for more information if needed.

Caching and performance

A working cache is required for the API to work correctly. Ensure APC is configured correctly when running this outside of the docker environment. Outgoing requests to NMBS servers should always be limited as much as possible!

Update stations list

Stations are updated through the irail/stations composer package. Just perform a composer update in the root of the project.

More links

irail's Projects

belaws icon belaws

The first simple and open-source website to find Belgian laws

belawshub icon belawshub

back and frontend to juridical information in belgium

betrains.qt icon betrains.qt

Qt MVC framework for BeTrains applications using libqtrail.

brail2gtfs icon brail2gtfs

[DEPRECATED] GTFS generator for the Belgian Railway company in PHP -- Use the official GTFS now

brail2stoptimes icon brail2stoptimes

[experiment] Creates a node.js stream of stoptimes for the Belgian Railways

brailresource icon brailresource

Resource for The DataTank to adapt the XML interface of the Belgian railway company to JSON

circadia icon circadia

Circadia's main repository used on iRail Summer of code

commitment icon commitment

A tool for social networkers to show their support for your page

datawall icon datawall

The iRail data wall at De Krook library in Ghent!

dpm icon dpm

Data package manager is a command line tool and library for working with data packages - http://wiki.ckan.org/Data_Packages

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.