From 73a5c7fae9ffbe9ada721148c8c454a643aceebe Mon Sep 17 00:00:00 2001 From: Armand Philippot Date: Sun, 20 Feb 2022 16:11:50 +0100 Subject: 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. --- .../react-small-apps/apps/notebook/README.md | 31 ++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 public/projects/react-small-apps/apps/notebook/README.md (limited to 'public/projects/react-small-apps/apps/notebook/README.md') 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). -- cgit v1.2.3