aboutsummaryrefslogtreecommitdiffstats
path: root/public/projects/react-small-apps/apps/notebook/README.md
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2022-02-20 16:11:50 +0100
committerArmand Philippot <git@armandphilippot.com>2022-02-20 16:15:08 +0100
commit73a5c7fae9ffbe9ada721148c8c454a643aceebe (patch)
treec8fad013ed9b5dd589add87f8d45cf02bbfc6e91 /public/projects/react-small-apps/apps/notebook/README.md
parentb01239fbdcc5bbc5921f73ec0e8fee7bedd5c8e8 (diff)
chore!: restructure repo
I separated public files from the config/dev files. It improves repo readability. I also moved dotenv helper to public/inc directory and extract the Matomo tracker in the same directory.
Diffstat (limited to 'public/projects/react-small-apps/apps/notebook/README.md')
-rw-r--r--public/projects/react-small-apps/apps/notebook/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/public/projects/react-small-apps/apps/notebook/README.md b/public/projects/react-small-apps/apps/notebook/README.md
new file mode 100644
index 0000000..06df8dd
--- /dev/null
+++ b/public/projects/react-small-apps/apps/notebook/README.md
@@ -0,0 +1,31 @@
+# React Notebook
+
+A notebook implementation with React.
+
+## Requirements
+
+- Yarn
+
+## How to
+
+### Start the development version
+
+`yarn run start`
+
+### Start the build version:
+
+1. `yarn run build`
+2. (`yarn global add serve`)
+3. `serve -s build`
+
+## Previews
+
+You can see a live preview here: https://demo.armandphilippot.com/#notebook
+
+| Cover | Page |
+| --- | --- |
+| ![Cover preview](./public/preview-cover.jpg) | ![Page preview](./public/preview-page.jpg) |
+
+## License
+
+This project is open source and available under the [MIT license](../LICENSE).