README.md

   1 ##### Format code with ktlint checkstyle tool use the following command
   2
   3 `mvn process-sources -P format`
   4
   5
   6 ## Reference
   7 https://github.com/pinterest/ktlint
   8
   9 ## Getting started
  10
  11 ![Basic_Architecture](./docs/media/CDS.png)
  12
  13 ## Basic Requirements
  14 Before you can build this project, you must install and configure the following dependencies on your machine:
  15
  16   1- Java 8 SDK
  17
  18   2- Node and npm installed
  19
  20   3- Angular CLI & Angular v8
  21
  22   4- MySQL Database
  23
  24   5- maven
  25
  26 ## Running in Development Mode
  27
  28 * In the main project folder run `mvn clean install` command to install all libraries and dependencies for maven and npm.
  29
  30  1- Back-end MS
  31
  32   * create `sdnctl` table in MySQL
  33   * (Optional) You could run the project in a specific profile(dev, local) by adding `-Dspring.profiles.active=profile-name`
  34
  35 2- Loop-back server: that allow your request to reach the backend from cds-ui
  36  * move to `./cds-ui/server/` folder and run the  command `npm start`
  37
  38  3- cds-ui
  39
  40  * 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.
  41
  42 ## Using an IDE
  43
  44 **Front-end** you could use `vscode` or `webstorm`.
  45
  46 **Back-end** `Intellij` with kotlin plugin or any other editor
  47
  48
  49 ---
  50 For more information check the `docs` folder.