aboutsummaryrefslogtreecommitdiffstats
path: root/mascara/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mascara/README.md')
-rw-r--r--mascara/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/mascara/README.md b/mascara/README.md
new file mode 100644
index 000000000..6e3bfe96b
--- /dev/null
+++ b/mascara/README.md
@@ -0,0 +1,33 @@
+start the dual servers (dapp + mascara)
+```
+npm run mascara
+```
+
+### First time use:
+
+- navigate to: http://localhost:9001
+- Create an Account
+- go back to http://localhost:9002
+- open devTools
+- click Sync Tx
+
+### Tests:
+
+```
+npm run testMascara
+```
+
+Test will run in browser, you will have to have these browsers installed:
+
+- Chrome
+- Firefox
+- Opera
+
+
+### Deploy:
+
+Will build and deploy mascara via docker
+
+```
+docker-compose build && docker-compose stop && docker-compose up -d && docker-compose logs --tail 200 -f
+``` \ No newline at end of file