Gitiles
Code Review Sign In
gerrit.nordix.org / onap / ccsdk / cds / 0957b798c9d4946f3607e17674746a973e2044a6
commit0957b798c9d4946f3607e17674746a973e2044a6[log] [tgz]
authorthmsdt <thomas.kulik@telekom.de>Wed Aug 14 10:11:26 2024 +0200
committerthmsdt <thomas.kulik@telekom.de>Wed Aug 14 10:12:15 2024 +0200
treeecdfe0ed9d8b9c39440eb9fe687d6ab576ee4e01
parenta49a8eeeedd7eb8af25e844e7cc92c1ceb7cabf7 [diff]
new onap logo

Issue-ID: DOC-826

Change-Id: I2386b019dafefd78d57caa5b8ce1c3922478ed8d
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
2 files changed
tree: ecdfe0ed9d8b9c39440eb9fe687d6ab576ee4e01
  1. .github/
  2. cds-ui/
  3. components/
  4. docs/
  5. ms/
  6. py-modules/
  7. releases/
  8. .editorconfig
  9. .gitignore
  10. .gitreview
  11. .readthedocs.yaml
  12. INFO.yaml
  13. ONAP-Java-Code-Style.xml
  14. pom.xml
  15. README.md
  16. TagVersion.groovy
  17. version.properties
README.md

Controller Design Studio (CDS)

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

Run mvn clean install command to install all libraries and dependencies for the maven and npm. Run 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

Format code with ktlint checkstyle tool use the following command

mvn process-sources -P format

Reference: ktlint docs | ktlint codebase