openecomp-ui/README.md

   1 # ASDC - Amdocs Onboard UI App
   2
   3 ## Setup
   4
   5 ###Install `npm`
   6
   7 Install npm v8.6.0.
   8
   9 ###Install `Node.js`
  10
  11 Install node v14.17.1 (as in the pom.xml <nodeVersion>v14.17.1</nodeVersion>).
  12
  13 * To manage different versions of node, it is recommended to install "n" (https://github.com/tj/n).
  14
  15 ### Install `gulp`
  16
  17 install gulp by running the following command `npm install --global gulp-cli`
  18
  19 ## Build
  20
  21 ### Install DOX-UI
  22 * pull for latest changes
  23 * go to folder `../dox-sequence-diagram-ui`
  24 * run `npm install && npm run build`
  25
  26 #### Install onboarding-fe
  27 * go to the current project folder `openecomp-ui`
  28 * run `npm install`
  29 * create a copy of `devConfig.defaults.json` file and name it `devConfig.json` (it is already configured to gitignore, so it will not be pushed)
  30 * in `devConfig.json`:
  31   * set "proxyCatalogTarget" to the URL of the sdc-frontend; set "proxyTarget" to the URL of the sdc-onboard-backend (**pay attention, it is a JSON file**):
  32
  33     For example *http://\<host>:\<port>*
  34 * run `npm start`
  35 * your favorite UI will wait for you at: `http://localhost:9000/sdc1/#!/onboardVendor`
  36
  37 ## Troubleshooting
  38 | Problem                                    | Why is this happening                | Solution                                                                                                                                                                                |
  39 |--------------------------------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
  40 | Build (npm install) error                  | npm/node_modules cache               | If having problems with the compilation of  dox-sequence-diagram-ui and openecomp-ui, delete the node_modules and package-lock.json in each respective projects folder.                 |
  41 | 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>` |
  42 | 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://`   |