openecomp-ui/README.md

   1 # ASDC - Amdocs Onboard UI App
   2
   3 ## Setup
   4
   5 ##### Install `nodejs`:
   6
   7 download nodejs from here: https://nodejs.org/en/ (take the "current" version with latest features) & install it.
   8 ##### Install `gulp`
   9
  10 install gulp by running the following command `npm install --global gulp-cli`
  11
  12 ##### Install DOX-UI
  13 * pull for latest changes
  14 * go to folder `dox-sequence-diagram-ui`
  15 * run `npm install`
  16 * wait for it...
  17 * go to folder `openecomp-ui`
  18 * run `npm install`
  19 * 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)
  20 in that file.
  21
  22   populate the fields of the IP addresses of your BE machine you'd like to connect (**pay attention, it is a JSON file**):
  23
  24   For example *http://\<host>:\<port>*
  25 * run `npm start`
  26 * your favorite UI will wait for you at: `http://localhost:9000/sdc1/proxy-designer1#/onboardVendor`
  27
  28
  29
  30 #### Troubleshooting
  31 Problem | Why is this happening | Solution
  32 ------- | --------------------- | --------
  33 npm cannot reach destination | proxy | When within managed network, you should set your proxy to NPM as the following: <br> `npm config set proxy http://<host>:<port>` <br> `npm config set https-proxy http://<host>:<port>`
  34 git protocol is blocked and cannot connect | managed network rules for protocols        | When within managed network, you should set globally that when git protocol is used, then it will be replaced with "https" <br> `git config --global url."https://".insteadOf git://`