FSR/ese-website
19
2
Fork 0
Code Issues 1 Pull requests Actions Packages Projects Releases Wiki Activity

readme: add building section

Browse source
This commit is contained in:
Lyn Fugmann 2024-09-13 17:52:31 +02:00
parent 131c03549f
commit 49d63dea6d
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -4,7 +4,17 @@ This is the WIP rewrite of the ESE website.
## Building
(TODO)
To build the website, install the dependencies and run the build script:
```sh
npm install
npm run build
```
The output will be in `_site`.
You can also start a development server with auto-reloading:
```sh
npm run start
```
## Nix DevShell
A nix development shell that provides all required tools for developing and building the project is provided for convenience. Using it is by no means required, although we encourage it.