aboutsummaryrefslogtreecommitdiff
path: root/front-end/README.md
diff options
context:
space:
mode:
authorLibravatar vnugent <public@vaughnnugent.com>2024-01-20 23:49:29 -0500
committerLibravatar vnugent <public@vaughnnugent.com>2024-01-20 23:49:29 -0500
commit6cb7da37824d02a1898d08d0f9495c77fde4dd1d (patch)
tree95e37ea3c20f416d6a205ee4ab050c307b18eafe /front-end/README.md
inital commit
Diffstat (limited to 'front-end/README.md')
-rw-r--r--front-end/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/front-end/README.md b/front-end/README.md
new file mode 100644
index 0000000..c7ffe8b
--- /dev/null
+++ b/front-end/README.md
@@ -0,0 +1,25 @@
+# Simple Bookmark/front-end
+
+## Getting Started
+
+Basic repo setup and git information can be found in the [README.md](../README.md)
+
+### Project setup, install NPM dependencies
+
+```shell
+npm install
+```
+
+### Compiles and hot-reloads for development
+
+```shell
+npm run dev
+```
+
+### Build for production
+
+```shell
+npm run build
+```
+
+Finally, copy the output (dist) directory into the root of your webserver