summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-02-23 17:05:38 -0300
committerSebastian <sebasjm@gmail.com>2021-02-23 17:05:38 -0300
commitbf20cbfeb441dfc4d9a109e6e4502ebc37a10b02 (patch)
treec05b766e36c58ab848a96e50919859df4df3be94 /README.md
parent808934fae5968ae0d967bdd3d1d5f5ba9322881e (diff)
downloadmerchant-backoffice-bf20cbfeb441dfc4d9a109e6e4502ebc37a10b02.tar.gz
merchant-backoffice-bf20cbfeb441dfc4d9a109e6e4502ebc37a10b02.tar.bz2
merchant-backoffice-bf20cbfeb441dfc4d9a109e6e4502ebc37a10b02.zip
dist command
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4ae4d67..8785a0b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
## Merchant Admin Frontend
-Merchant Admin Frontend is a Single Page Application that connect with a running Merchant Backend and lets you manage instances, order, products and tippings
+Merchant Admin Frontend is a Single Page Application (SPA) that connect with a running Merchant Backend and lets you manage instances, order, products and tippings
## System requirements
@@ -43,7 +43,17 @@ make dev PORT=9090
## Building for deploy
-To
+To build and deploy the SPA in your local server run the install script
+
+```shell
+make install
+```
+
+Aditionally `make dist` will create a zip file with the content to upload into a server
+
+```shell
+make dist
+```
## CLI Commands
@@ -66,7 +76,6 @@ To
* `make dev-views`: Run visual components explorer. Usefull for components design and development
without the need of setting up the whole system.
-
## Runtime dependencies
* Axios: Promise based HTTP client for the browser and node.js