README.md

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