diff options
author | Filip Figiel <figiel.filip@gmail.com> | 2022-05-23 20:36:17 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-23 19:36:17 +0100 |
commit | 03030ea62b59e859e068aa76eb1692dd1ef807f7 (patch) | |
tree | 5ae3914488446e52ebc27f341e9d10942ad01bb9 /example/README.md | |
parent | cb67e922d996077154dfdd05961071b2cc8cc7fc (diff) | |
download | lustre-03030ea62b59e859e068aa76eb1692dd1ef807f7.tar.gz lustre-03030ea62b59e859e068aa76eb1692dd1ef807f7.zip |
🔀📝 add a fully-fledged example project (#2)
* docs: add a full-fledged example project
* fix: use correct script path
* docs: improve example readme commands
* chore: ignore the dist folder
* chore: cleanup the makefile
Diffstat (limited to 'example/README.md')
-rw-r--r-- | example/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000..014e017 --- /dev/null +++ b/example/README.md @@ -0,0 +1,21 @@ +# lustre_counter + +This is an example Lustre project. It uses [watchexec](https://github.com/watchexec/watchexec) to rebuild the Gleam project on save. + +## Quick start + +Initial setup: +```sh +npm install +gleam build +``` + +Run dev server on `localhost:3000`: +```sh +make dev +``` + +Make a production build under `dist` folder: +```sh +make +``` |