OpenRailAssociation / osrd

An open source web application for railway infrastructure design, capacity analysis, timetabling and simulation
https://osrd.fr
436 stars 40 forks source link

Replace osrd-project NGE fork by SBB NGE package #8349

Open louisgreiner opened 1 month ago

louisgreiner commented 1 month ago

Who would benefit from this feature?

Software developers

What is this feature about?

Currently, the integration of NGE in OSRD requires a fork of NGE with several patches to use the NPM package that we can't apply for now directly in NGE official repo. It is mainly due to concepts that we can't implement for now, for functionnalities that require prior refactor to be used by the standalone environment (= backend disabled, no auth, some UI components disabled) that we are using.

However, this is time consuming to keep this fork up to date (thank you Simon!), as we have to manually integrate the latest updates form NGE, and also it can be dangerous as we could diverge very fast if we implement too much patches.

The forked and official NPM packages is published in NPM.

Here is the list of the patches implemented in the fork that we want to get rid of and handle directly upstream in NGE official repo (diff):

Why is this feature valuable?

Working with a custom NGE package

To work with a custom NGE package and publish a new version, available here