Github user iraghumitra commented on a diff in the pull request:
https://github.com/apache/metron/pull/620#discussion_r129769257
--- Diff: metron-interface/metron-alerts/README.md ---
@@ -0,0 +1,80 @@
+- [Caveats](#caveats)
+- [Prerequisites](#prerequisites)
+- [Development Setup](#development-setup)
+- [E2E Tests](#e2e-tests)
+- [Mpack Integration](#mpack-integration)
+- [Installing on an existing Cluster](#installing-on-an-existing-cluster)
+
+## Caveats
+* UI doesn't have an authentication module yet
+* UI uses local storage to save all the data. A middleware needs to be
designed and developed for persisting the data
+
+## Prerequisites
+* Elastic search should be up and running and should have some alerts
populated by metron topologies
+* The alerts can be populated using Quick Dev, Full Dev or any other setup
+* UI is developed using angular4 and uses angular-cli
+* node.JS >= 7.8.0
+
+## Development Setup
+
+Install all the dependent node_modules using the following command
+```
+cd incubator-metron/metron-interface/metron-alerts
+npm install
+```
+UI can be run by using the following command
+```
+./scripts/start-dev.sh
+```
+**NOTE**: *In the development mode ui by default connects to ES at
http://node1:9200 for fetching data. If you wish to change it you can change
the ES url at incubator-metron/metron-interface/metron-alerts/proxy.conf.json*
+
+## E2E Tests
+
+An expressjs server is available for mocking the elastic search api.
+
+1. Run e2e webserver :
+ ```
+ cd incubator-metron/metron-interface/metron-alerts
--- End diff --
Done
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
