OSRD is a work in progress tool meant to help design and operate railway infrastructure. It's built around a simulator, which evaluates a timetable on a given infrastructure.
It's free and open-source forever!
git clone --recurse-submodules git@github.com:osrd-project/osrd-website.git
This repository uses submodules. Please read the following carefuly
If you forgot --recurse-submodules at clone time, run:
git submodule update --init --recursive
If you made some changes in the theme repository, you have to update the submodule:
git submodule update --remote
If somebody already commited the submodule update, either pull with the proper submodule update flag:
git pull -r --recurse-submodules
or update the submodule after the fact:
git submodule update
Otherwise, the submodule folder will not be updated.
- Install Node Version Manager
nvm installto set the right node and npm version using nvmnpm installto install all the project dependencies(cd themes/docsy && npm install)to install theme dependenciesnpm run startto get a development servernpm run buildto make a production build
First, install theme dependencies:
docker run --rm -it \
-v $(pwd):/src \
-w /src/themes/docsy \
--entrypoint npm \
klakegg/hugo:ext-alpine \
install
docker run --rm -it -v $(pwd):/src -p 1313:1313 klakegg/hugo:ext-alpine server
docker run --rm -it -v $(pwd):/src klakegg/hugo:ext-alpine
Click the button below to start a new development environment using Gitpod :
You can use devcontainer to run this website. Please read documentation before.
You can use Codespace based on devcontainer to set up a remote development environment and run this website. For french developers Codespace is still in beta.
If you think OSRD doesn't quite fit your needs yet, but still believe it could, please tell us about your needs.
Please consider committing resources to help development if you'd like to use OSRD in production. Code contributions are very welcome, and we'd love to work together to make this project better.
You are interested in the project, and you want to know more? Contact us at contact@osrd.fr.