about summary refs log tree commit diff
path: root/website/sandbox/nut-score/README.md
diff options
context:
space:
mode:
authorWilliam Carroll <wpcarro@gmail.com>2020-03-24T12·29+0000
committerWilliam Carroll <wpcarro@gmail.com>2020-03-24T12·29+0000
commit57b58e9b2fe2a1b178f42bc16d7c5ab1f8da9cdd (patch)
treef73b035061d0d1cdf9e7cf1545e2b48d654065b8 /website/sandbox/nut-score/README.md
parent2551b41d735cb1446fa5ecae496d079ca4741e46 (diff)
Move nut-score into website/sandbox
Also move some .gitignore entries from the top-level .gitignore into a
subdirectory .gitignore.
Diffstat (limited to 'website/sandbox/nut-score/README.md')
-rw-r--r--website/sandbox/nut-score/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/website/sandbox/nut-score/README.md b/website/sandbox/nut-score/README.md
new file mode 100644
index 000000000000..585967b8beb4
--- /dev/null
+++ b/website/sandbox/nut-score/README.md
@@ -0,0 +1,35 @@
+# Nut Score
+
+I cloned most of this start boilerplate from
+github.com/BuckleScript/bucklescript by running the following:
+
+```shell
+$ cd ~/programming
+$ git clone git@github.com:BuckleScript/bucklescript
+$ cp -R ./jscomp/bab/templates/react-hooks ~/briefcase/nut-score
+```
+
+## Installing
+
+```shell
+$ nix-shell
+$ yarn install
+```
+
+## Developing
+
+In one shell run:
+
+```shell
+$ nix-shell
+$ yarn server
+```
+
+In another shell run:
+
+```shell
+$ nix-shell
+$ yarn start
+```
+
+Now open a web browser and visit `localhost:8000`.