diff --git a/README.md b/README.md index 0b5cf10fc87d22e3e55571c56418cf4b6e52267c..bfddaa8a59120b2c8c1835ac81a578b8cd9506fc 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,25 @@ Web interface meant to be served at [nyx.pasteur.cloud](https://nyx.pasteur.clou It features an app catalog, with currently a single available app: * an editor for muscular activity programs. + + +## Local installation + +For local execution, the installation instructions are as follows: + +You will need [JuliaUp](https://github.com/JuliaLang/juliaup?tab=readme-ov-file#juliaup---julia-version-manager) and [git](https://git-scm.com/downloads). + +Once these tools are installed, in a terminal (on Windows, preferably PowerShell), type: +``` +git clone --branch dev https://gitlab.pasteur.fr/nyx/NyxUI.jl NyxUI +cd NyxUI +cp front/Manifest.toml . +juliaup add lts +juliaup default lts +julia --project=. -e 'using Pkg; Pkg.instantiate()' +julia --project=. routes.jl +``` + +You may be asked whether to authorize ports 9284 and 9285; please give the app permission. + +From there, in a web browser, open http://localhost:9284/ to access the app.