summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAhmed Abdelhalim <[email protected]>2021-05-04 03:53:32 +0200
committerAhmed Abdelhalim <[email protected]>2021-05-04 03:53:32 +0200
commitd77ab36400bb40b9b6812ac47d1b796fe2836d17 (patch)
tree88870d64909af090e107df789cb1f3a173566dbb /README.md
parentc000cfeaa38e8e8b841433c6b021771d3ade43b2 (diff)
Add simple README
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2413f91
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Prerequisites :
+- Node v12 (or higher): `brew install node`
+- Yarn: `brew install yarn`
+
+# Installation :
+- Clone the repo.
+- Run `yarn install`
+
+# Development :
+- Run `yarn start`
+
+# Build :
+- Run `yarn build`
+- Copy the generated `public` directory to any hosting environment.