Gitiles
Code Review Sign In
gerrit.nordix.org / onap / ccsdk / cds / refs/heads/istanbul
commitb37d6519e9401b30e6b7d3eadaeb305bfc4ea6b0[log] [tgz]
authorCédric Ollivier <cedric.ollivier@orange.com>Mon Apr 11 16:28:46 2022 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>Mon Apr 11 16:34:48 2022 +0200
tree85d31239e8c4260f22088c473b07efb164b25538
parent6944ef1c7545aecc8827dd1fdd07d0c6ee685bee [diff]
Add bounds to sphinx requirement

As ONAP was created before Oct 20 2020 in RTD, we
must set bounds to enforce a compatible Sphinx version
(see manual).

It also applied fixes which were applied during the
previous release in all repos.

Issue-ID: DOC-782
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: I684efed16ac46552bfaa989ded2a4515ee6cc6a0
(cherry picked from commit 2264544baa8d38930d60524c806cd32c1e7ac045)
2 files changed
tree: 85d31239e8c4260f22088c473b07efb164b25538
  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