README.md

OSRD scripts:

launch them while you're in osrd directory

setup-osrd

this script gives you the ability to choose between two options or both:

• setup the docker configuration:
  • remove all the containers
  • remove all the images
  • remove all the volumes
  • setup a new configuration based on the docker-compose.yml file or the host configuration file if you give at least one argument and run the project on a linux system
• setup data:
  • restore a backup if you have a single *.backup file in the the parent directory
  • setup a light configuration based in the osrd scripts if you don't have a *.backup file

Caution

You should not use this script automatically, its only purpose is to help you in a last resort situation or for first setup if you're not familiar with the project

OSRD-UI scripts:

launch them while you're in osrd-ui directory

reset-ui

this script will setup a fresh installation of the osrd-ui project by:

1. remove the node_modules and the package-lock.json in the osrd-ui directory if they exist
2. list all ui-* Subdirectories
3. remove the node_modules, dist directories and the package-lock.json file in each ui-* Subdirectory if they exist
4. run npm install in the osrd-ui directory
5. run npm run build in the osrd-ui directory

create-tag

this script will:

1. create a new annotated tag if:
   • you give it a tag name as an argument
   • the tag name follows the pattern *.*.* where * is a number
   • the tag name is not already used
2. push the tag to the remote repository

about this repository

this repository is a collection of scripts that will help you to manage the OSRD project and the OSRD-UI project.
it's not part of the OSRD project itself,
it's just a helper for the developers who are contributing to the project.

License

This project is licensed under the GNU Lesser General Public License. See the LICENSE file for more details.