summaryrefslogtreecommitdiffstats
path: root/openecomp-ui/readMe.txt
diff options
context:
space:
mode:
Diffstat (limited to 'openecomp-ui/readMe.txt')
-rw-r--r--openecomp-ui/readMe.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/openecomp-ui/readMe.txt b/openecomp-ui/readMe.txt
new file mode 100644
index 0000000000..6b70dfc5bb
--- /dev/null
+++ b/openecomp-ui/readMe.txt
@@ -0,0 +1,25 @@
+# OpenECOMP SDC(UI)
+
+---
+---
+
+# Steps
+
+### Install nodejs & gulp
+
+#### Download nodejs from here : https://nodejs.org/en/ (take the "current" version with latest features) & install it.
+#### Install gulp by running the following command : npm install --global gulp-cli
+
+### Install DOX-UI a
+
+#### Pull for latest changes.
+#### Go to folder dox-sequence-diagram-ui
+#### Give the following command : run npm install
+#### Wait for it..
+#### Go to folder dox-ui
+#### run npm install
+#### Create a copy of devConfig.defaults.json file and name it devConfig.json (we already configured git to ignore it so it will not be pushed).
+#### In that file, populate the fields of the IP addresses of your BE machine you'd like to connect (pay attention, it is a JSON file): For example, http://<host>:<port>
+#### After everything was successful, run gulp.
+#### After server was up, your favourite UI will wait for you at : http://localhost:9000/sdc1/proxy-designer1#/onboardVendor
+