Gitiles
Code Review Sign In
gerrit.nordix.org / onap / ccsdk / cds / dc8252f3cfa1ddd0c1c8c70513c16c738d840822
commitdc8252f3cfa1ddd0c1c8c70513c16c738d840822[log] [tgz]
authorSingal, Kapil (ks220y) <ks220y@att.com>Thu Jan 21 19:34:39 2021 -0500
committerSingal, Kapil (ks220y) <ks220y@att.com>Thu Jan 21 19:34:39 2021 -0500
treecc84efc92f6ad34e8d52db56cef4a84aa8b80766
parentf8c5f58ce8b2b076d5874508873829a33cc545b0 [diff]
Fixing Blueprint Typo's and docs

Issue-ID: CCSDK-3098
Signed-off-by: Singal, Kapil (ks220y) <ks220y@att.com>
Change-Id: I0cd5ba75a9ebb0363e7eab15ee0710b01e76b897
4 files changed
tree: cc84efc92f6ad34e8d52db56cef4a84aa8b80766
  1. cds-ui/
  2. components/
  3. docs/
  4. ms/
  5. py-modules/
  6. releases/
  7. .editorconfig
  8. .gitignore
  9. .gitreview
  10. .readthedocs.yaml
  11. INFO.yaml
  12. ONAP-Java-Code-Style.xml
  13. pom.xml
  14. README.md
  15. TagVersion.groovy
  16. version.properties
README.md

Format code with ktlint checkstyle tool use the following command

mvn process-sources -P format

Reference: ktlint docs | ktlint codebase

Basic Architecture

Basic_Architecture

Basic Requirements

Before you can build this project, you must install and configure the following dependencies on your machine:

  1. Java 11 SDK
  2. Maven 3.6.X
  3. MySQL Database
  4. Node and npm installed
  5. Angular CLI & Angular v8

Running in Development Mode

Running mvn clean install command to install all libraries and dependencies for the maven and npm. Running mvn clean install -Pdocker command to install all libraries and create below docker images.

  • ccsdk-blueprintsprocessor
  • ccsdk-commandexecutor
  • ccsdk-py-executor
  • ccsdk-sdclistener
  • ccsdk-cds-ui-server
  • ccsdk-cds-ui

Note: run mvn clean install -Pdocker -Ddocker.skip.push=true to build but skip pushing docker image.

  1. Back-end MS

    Create sdnctl table in MySQL
    (Optional) You could run the project in a specific profile(dev, local) by adding -Dspring.profiles.active=profile-name

  2. Loop-back server:

    That allow your request to reach the backend from cds-ui
    Move to ./cds-ui/server/ folder and run the command npm start

  3. cds-ui

    Move to ./cds-ui/designer-client/ folder and run the command npm start
    This command will make sure all the files follow the linting rules and then connect to the loopback server.

Using an IDE

Front-end: you could use vscode or webstorm
Back-end: IntelliJ with kotlin plugin or any other editor

For more information check: CDS Docs