README.md

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