nixin-web/installation.md
Florian Schmitt aa0665f243
Some checks failed
deploy to prod / Build and deploy site (push) Failing after 25s
feat: about page + tweaks + links between pages
2024-10-01 15:35:14 +03:00

30 lines
802 B
Markdown

# Installation
## Requirements
For now, the NixiN installation process was just tested on a Linux distribution, on a computer with virtualisation capacities.
So only requirements are :
- A Linux system with virtualisation support
- With Nix installed <https://nix.dev/manual/nix/stable/installation/installation.html>
## Grab the code and build the dev environment
Get the latest version from the official repository
```bash
git clone https://git.distrilab.fr/NixiN/nixin-web
```
Go in the main folder and run the `shell.nix` to install dependencies
```bash
cd nixin-web && nix-shell
```
## Run locally
From the development shell run `npm run docs:dev` to launch the website locally, in development mode.
The site should be accessible at <http://localhost:5173> (or any configured port).