Merge pull request 'Improve quickstart development docs' (#13) from update-readme into main
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
Reviewed-on: #13 Reviewed-by: b12f <hello@benjaminbaedorf.eu>
This commit is contained in:
commit
b6eabd9c14
19
README.md
19
README.md
|
@ -3,19 +3,30 @@
|
|||
This is the repository containing the code for https://pub.solar.
|
||||
|
||||
It is built using [lume](https://lume.land/) with JSX. To get started, make sure
|
||||
you're loading all dependencies via `direnv`:
|
||||
you have the [nix package manager](https://nixos.org/download.html) installed.
|
||||
Then you can start developing with:
|
||||
|
||||
```
|
||||
$ direnv allow
|
||||
nix develop
|
||||
```
|
||||
|
||||
This will use nix shell to create an environment that has deno and lume
|
||||
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
|
||||
```
|
||||
|
||||
To get a live development server, run
|
||||
|
||||
```
|
||||
$ deno task serve
|
||||
deno task serve
|
||||
```
|
||||
|
||||
Unfortunately, hot module reloading is currently broken for JSX modules, so
|
||||
|
|
Loading…
Reference in a new issue