Merge pull request 'Improve quickstart development docs' (#2) from update-readme into main
All checks were successful
continuous-integration/drone/push Build is passing

Reviewed-on: #2
This commit is contained in:
b12f 2023-07-03 14:36:02 +02:00
commit fbe49ab026
Signed by: pub.solar gitea
GPG key ID: F0332B04B7054873

View file

@ -1,17 +1,36 @@
Install Lume:
# miom.space homepage
https://lume.land/docs/overview/installation/
This is the repository containing the code for https://miom.space.
It is built using [lume](https://lume.land/) with JSX. To get started, make sure
you have the [nix package manager](https://nixos.org/download.html) installed.
Then you can start developing with:
```
deno run -Ar https://deno.land/x/lume/init.ts
nix develop
```
Build the project:
This will use a [nix devshell](https://nix.dev/tutorials/first-steps/ad-hoc-shell-environments#ad-hoc-envs)
to create an environment that has [deno](https://deno.land/) and [lume](https://lume.land/)
available.
An alternative approach for loading all dependencies is [`direnv`](https://direnv.net).
It basically runs `nix develop` for you, once you enter a directory which
contains a `.envrc` file and allow it by running `direnv allow`. Once installed
globally, run:
```
direnv allow
```
Just build the static site, results are in `_site`:
```
./build.sh
```
Run a local version of the project:
To get a live development server, run:
```
deno task serve
```