README.md

   1 # Controller Design Studio (CDS)
   2
   3 ## Basic Architecture
   4 ![Basic_Architecture](./docs/media/CDS_architecture.jpg)
   5
   6 ## Basic Requirements
   7 Before you can build this project, you must install and configure the following dependencies on your machine:
   8   1) Java 11 SDK
   9   2) Maven 3.6.X
  10   3) MySQL Database
  11   4) Node and npm installed
  12   5) Angular CLI & Angular v8
  13
  14 ## Running in Development Mode
  15 Run `mvn clean install` command to install all libraries and dependencies for the maven and npm.
  16 Run `mvn clean install -Pdocker` command to install all libraries and create below docker images.
  17   * ccsdk-blueprintsprocessor
  18   * ccsdk-commandexecutor
  19   * ccsdk-py-executor
  20   * ccsdk-sdclistener
  21   * ccsdk-cds-ui-server
  22   * ccsdk-cds-ui
  23
  24 **Note:** Run `mvn clean install -Pdocker -Ddocker.skip.push=true` to build but skip pushing docker image.
  25
  26 1) Back-end MS
  27    >Create `sdnctl` table in MySQL<br>
  28    >(Optional) You could run the project in a specific profile(dev, local) by adding `-Dspring.profiles.active=profile-name`
  29
  30 2) Loop-back server:
  31    >That allow your request to reach the backend from cds-ui<br>
  32    >Move to `./cds-ui/server/` folder and run the  command `npm start`
  33
  34 3) cds-ui
  35    >Move to `./cds-ui/designer-client/` folder and run the command `npm start`<br>
  36    >This command will make sure all the files follow the linting rules and then connect to the loopback server.
  37
  38 ## Using an IDE
  39 **Front-end:** you could use `vscode` or `webstorm`<br>
  40 **Back-end:** `IntelliJ` with kotlin plugin or any other editor
  41
  42 ---
  43 For more information check: [CDS Docs](https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html)
  44
  45 ### Format code with ktlint checkstyle tool use the following command
  46 `mvn process-sources -P format`
  47
  48 **Reference:** [ktlint docs](https://ktlint.github.io/) | [ktlint codebase](https://github.com/pinterest/ktlint)