X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.md;h=a95b9c47e809fbd7fb39a7ceebbd9e1dfd28facb;hb=refs%2Fheads%2Fmaster;hp=ba9c293570400c299871d6e504aaaa8b3b09d96b;hpb=aad8261cf84e3ccf59d9494a98277ddcde2dea67;p=ccsdk%2Fcds.git diff --git a/README.md b/README.md index ba9c29357..a95b9c47e 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,48 @@ -##### Format code with ktlint checkstyle tool use the following command +# Controller Design Studio (CDS) -`mvn process-sources -P format` - - -## Reference -https://github.com/pinterest/ktlint - -## Getting started - -![Basic_Architecture](./docs/media/CDS.png) +## Basic Architecture +![Basic_Architecture](./docs/media/CDS_architecture.jpg) ## Basic Requirements Before you can build this project, you must install and configure the following dependencies on your machine: + 1) Java 11 SDK + 2) Maven 3.6.X + 3) MySQL Database + 4) Node and npm installed + 5) Angular CLI & Angular v8 - 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 +Run `mvn clean install` command to install all libraries and dependencies for the maven and npm. +Run `mvn clean install -Pdocker` command to install all libraries and create below docker images. + * ccsdk-blueprintsprocessor + * ccsdk-commandexecutor + * ccsdk-py-executor + * ccsdk-sdclistener + * ccsdk-cds-ui-server + * ccsdk-cds-ui + +**Note:** Run `mvn clean install -Pdocker -Ddocker.skip.push=true` to build but skip pushing docker image. + +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` - * 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 +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` - * 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. +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 -**Front-end** you could use `vscode` or `webstorm`. - -**Back-end** `Intellij` with kotlin plugin or any other editor +--- +For more information check: [CDS Docs](https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html) +### Format code with ktlint checkstyle tool use the following command +`mvn process-sources -P format` ---- -For more information check the `docs` folder. \ No newline at end of file +**Reference:** [ktlint docs](https://ktlint.github.io/) | [ktlint codebase](https://github.com/pinterest/ktlint)