Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
bgColorWhite
titleTable of Contents


Info

How to Get Started with CDS Designer UI

If you’re new to CDS Designer UI and need to get set up, the following guides may be helpful:

Anchor
Prerequisites
Prerequisites

Prerequisites

Node version: >= 8.9

NPM version: >=6.4.1

Anchor
Check-outCode
Check-outCode

Check-out code

Code Block
themeDJango
git clone "https://gerrit.onap.org/r/ccsdk/cds"

Anchor
InstallNodeModulesUI
InstallNodeModulesUI

Install Node Modules (UI)

From cds-ui/client directory, execute npm install to fetch project dependent Node modules 

Anchor
InstallNodeModulesServer
InstallNodeModulesServer

Install Node Modules (Server)

From cds-ui/server directory, execute npm install to fetch project dependent Node modules 

Anchor
RunUIinDevelopmentMode
RunUIinDevelopmentMode

Run UI in Development Mode

From cds-ui/client directory, execute npm start to run the Angular Live Development Server

Code Block
themeDJango
nirvanr01-mac:client nirvanr$ npm start

> cds-ui@0.0.0 start /Users/nirvanr/dev/git/onap/ccsdk/cds/cds-ui/client
> ng serve

** Angular Live Development Server is listening on localhost:4200, open your browser on http://localhost:4200/ **

Anchor
RunUIServer
RunUIServer

Run UI Server

From cds-ui/client directory, execute mvn clean compile then npm run build to copy all front-end artifacts to server/public directory

...

Code Block
themeDJango
nirvanr01-mac:server nirvanr$ npm run start

> cds-ui-server@1.0.0 prestart /Users/nirvanr/dev/git/onap/ccsdk/cds/cds-ui/server
> npm run build


> cds-ui-server@1.0.0 build /Users/nirvanr/dev/git/onap/ccsdk/cds/cds-ui/server
> lb-tsc es2017 --outDir dist


> cds-ui-server@1.0.0 start /Users/nirvanr/dev/git/onap/ccsdk/cds/cds-ui/server
> node .

Server is running at http://127.0.0.1:3000
Try http://127.0.0.1:3000/ping

Anchor
BuildUIDockerImage
BuildUIDockerImage

Build UI Docker Image

From cds-ui/server directory, execute docker build -t cds-ui . to build a local CDS-UI Docker image

Code Block
themeDJango
nirvanr01-mac:server nirvanr$ docker build -t cds-ui .
Sending build context to Docker daemon  96.73MB
Step 1/11 : FROM node:10-slim
 ---> 914bfdbef6aa
Step 2/11 : USER node
 ---> Using cache
 ---> 04d66cc13b46
Step 3/11 : RUN mkdir -p /home/node/app
 ---> Using cache
 ---> c9a44902da43
Step 4/11 : WORKDIR /home/node/app
 ---> Using cache
 ---> effb2329a39e
Step 5/11 : COPY --chown=node package*.json ./
 ---> Using cache
 ---> 4ad01897490e
Step 6/11 : RUN npm install
 ---> Using cache
 ---> 3ee8149b17e2
Step 7/11 : COPY --chown=node . .
 ---> e1c72f6caa15
Step 8/11 : RUN npm run build
 ---> Running in 5ec69a1961d0

> cds-ui-server@1.0.0 build /home/node/app
> lb-tsc es2017 --outDir dist

Removing intermediate container 5ec69a1961d0
 ---> ec9fb899e52c
Step 9/11 : ENV HOST=0.0.0.0 PORT=3000
 ---> Running in 19963303a09c
Removing intermediate container 19963303a09c
 ---> 6b3b45709e27
Step 10/11 : EXPOSE ${PORT}
 ---> Running in 78b9833c5050
Removing intermediate container 78b9833c5050
 ---> 3835c14ad17b
Step 11/11 : CMD [ "node", "." ]
 ---> Running in 79a98e6242dd
Removing intermediate container 79a98e6242dd
 ---> c41f6e6ba4de
Successfully built c41f6e6ba4de
Successfully tagged cds-ui:latest

Anchor
RunUIDockerImage
RunUIDockerImage

Run UI Docker Image

Create docker-compose.yaml as below. 

...

Code Block
themeDJango
nirvanr01-mac:cds nirvanr$ docker-compose up cds-ui
Creating cds-ui ... done
Attaching to cds-ui
cds-ui                   | Server is running at http://127.0.0.1:3000
cds-ui                   | Try http://127.0.0.1:3000/ping



...

Next: CDS Designer UI

...