1 files changed, 64 insertions, 0 deletions
diff --git a/src/tools/emcoui/README.md b/src/tools/emcoui/README.md
new file mode 100644
index 00000000..05a43237
--- /dev/null
+++ b/src/tools/emcoui/README.md
@@ -0,0 +1,64 @@
+# EMCOUI
+
+This is a web app for EMCO V2 api's. This is a reactjs based UI app created using google material ui library.
+
+## Local setup
+
+for running the app in a local setup first install the dependencies by running
+
+```bash
+npm install
+```
+
+Then run
+
+```bash
+startup.sh
+```
+
+## Production build
+
+for creating a production build, run
+
+```bash
+npm run build
+```
+
+A production ready build will be available at /build directory
+
+## Available scripts
+
+### `startup.sh`
+
+This script basically calls npm start.
+This script runs the app in the development mode.<br />
+Before running the script update the backend address if backend is not running locally.
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br />
+You will also see any lint errors in the console.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.<br />
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br />
+
+## Building docker image
+
+To build a docker image run the below command
+
+```bash
+docker build -t <image_name>:<image_version> .
+```
+
+## Installing with helm
+
+All the helm chars are in `helm` directory.
+
+Update values.yaml in `helm` directory with the required emcoui image and then run
+
+```bash
+helm install --name <app name> --namespace < namespace >
+```