pub-solar/pub.solar
5
2
Fork 2
Code Issues Pull requests Packages Projects Releases Wiki Activity

Improve quickstart development docs #13

Merged
b12f merged 1 commit from update-readme into main 2023-07-03 12:35:38 +00:00
Conversation 0 Commits 1 Files changed 1 +15 -4
1 changed files with 15 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -3,19 +3,30 @@
This is the repository containing the code for https://pub.solar. 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 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. 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 To get a live development server, run
``` ```
$ deno task serve deno task serve
``` ```
Unfortunately, hot module reloading is currently broken for JSX modules, so Unfortunately, hot module reloading is currently broken for JSX modules, so