diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 23 insertions, 21 deletions
@@ -1,50 +1,52 @@ -##### Format code with ktlint checkstyle tool use the following command - +### Format code with ktlint checkstyle tool use the following command `mvn process-sources -P format` - -## Reference +#### Reference https://github.com/pinterest/ktlint -## Getting started - +## Basic Architecture  ## Basic Requirements Before you can build this project, you must install and configure the following dependencies on your machine: - 1- Java 8 SDK - + 1- Java 11 SDK 2- Node and npm installed - 3- Angular CLI & Angular v8 - 4- MySQL Database - - 5- maven + 5- Maven 3.6.X ## Running in Development Mode -* In the main project folder run `mvn clean install` command to install all libraries and dependencies for maven and npm. +Running `mvn clean install` command to install all libraries and dependencies for the maven and npm. +Running `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 - 1- Back-end MS - - * create `sdnctl` table in MySQL +**Note:** run `mvn clean install -Pdocker -Ddocker.skip.push=true` to skip pushing built 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` -2- Loop-back server: that allow your request to reach the backend from 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` - 3- cds-ui +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. + * 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 +**Back-end** `IntelliJ` with kotlin plugin or any other editor --- -For more information check the `docs` folder.
\ No newline at end of file +For more information check: https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html
\ No newline at end of file |