Gitiles
Code Review Sign In
gerrit.nordix.org / onap / ccsdk / cds / 807f3df7b8d523040a65b805355f180551c3018c
commit807f3df7b8d523040a65b805355f180551c3018c[log] [tgz]
authorSarah Abouzainah <sabouzainah.ext@orange.com>Wed Jun 10 10:47:29 2020 +0200
committerSarah Abouzainah <sabouzainah.ext@orange.com>Wed Jun 10 10:47:29 2020 +0200
tree8396d2311e2ae67e5fc661b99f1628dd9da07224
parent8a3d5215f2424bbea855ac1b86dfefb98f349496 [diff]
Create CDS Designer Guide for docs.onap

Issue-ID: CCSDK-2415

Signed-off-by: Sarah Abouzainah <sabouzainah.ext@orange.com>
Change-Id: I94d981b5ce48b995a75de92df91a58ce163a5520
2 files changed
tree: 8396d2311e2ae67e5fc661b99f1628dd9da07224
  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. pom.xml
  13. README.md
  14. TagVersion.groovy
  15. version.properties
README.md
Format code with ktlint checkstyle tool use the following command

mvn process-sources -P format

Reference

https://github.com/pinterest/ktlint

Getting started

Basic_Architecture

Basic Requirements

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

1- Java 8 SDK

2- Node and npm installed

3- Angular CLI & Angular v8

4- MySQL Database

5- maven

Running in Development Mode

  • In the main project folder run mvn clean install command to install all libraries and dependencies for maven and npm.

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 the docs folder.