From 64f57d8e05e56fb1c1ac964795b785b081f59cad Mon Sep 17 00:00:00 2001 From: Fiete Ostkamp Date: Tue, 27 Dec 2022 12:20:23 +0000 Subject: [PATCH] Minor improvements for the README - fix broken link to architecture picture - improve document structure - improve cds-ui/server README Issue-ID: CCSDK-3825 Signed-off-by: Fiete Ostkamp Change-Id: I00087a8fa31bad2c4bcaebae487940e7af4807c0 --- README.md | 20 +++++++++-------- cds-ui/client/package-lock.json | 38 ++++++++++++++++++++++++-------- cds-ui/designer-client/package-lock.json | 2 +- cds-ui/server/README.md | 11 +++++++-- 4 files changed, 50 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index fc87d1264..a95b9c47e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,7 @@ -### Format code with ktlint checkstyle tool use the following command -`mvn process-sources -P format` - -**Reference:** [ktlint docs](https://ktlint.github.io/) | [ktlint codebase](https://github.com/pinterest/ktlint) +# Controller Design Studio (CDS) ## Basic Architecture -![Basic_Architecture](./docs/media/CDS.png) +![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: @@ -15,8 +12,8 @@ Before you can build this project, you must install and configure the following 5) Angular CLI & Angular v8 ## Running in Development Mode -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. +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 @@ -24,7 +21,7 @@ Running `mvn clean install -Pdocker` command to install all libraries and create * ccsdk-cds-ui-server * ccsdk-cds-ui -**Note:** run `mvn clean install -Pdocker -Ddocker.skip.push=true` to build but skip pushing docker image. +**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
@@ -43,4 +40,9 @@ Running `mvn clean install -Pdocker` command to install all libraries and create **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) \ No newline at end of file +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` + +**Reference:** [ktlint docs](https://ktlint.github.io/) | [ktlint codebase](https://github.com/pinterest/ktlint) diff --git a/cds-ui/client/package-lock.json b/cds-ui/client/package-lock.json index 3c26385a3..7fbbcd89b 100644 --- a/cds-ui/client/package-lock.json +++ b/cds-ui/client/package-lock.json @@ -1144,6 +1144,11 @@ "integrity": "sha512-TmlYodTNhMzVzv3CK/9sXGzh31jWsRKHE3faczhVgYFCdXIRQRCOPD+0NDlR+SvJlCj914yP3q3aAupt53p2Ug==", "dev": true }, + "@types/mime": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@types/mime/-/mime-2.0.3.tgz", + "integrity": "sha512-Jus9s4CDbqwocc5pOAnh8ShfrnMcPHuJYzVcSUU7lrh8Ni5HuIqX3oilL86p3dlTrk0LzHRCgA/GQ7uNCw6l2Q==" + }, "@types/node": { "version": "8.10.59", "resolved": "https://registry.npmjs.org/@types/node/-/node-8.10.59.tgz", @@ -4683,12 +4688,14 @@ "balanced-match": { "version": "1.0.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "brace-expansion": { "version": "1.1.11", "bundled": true, "dev": true, + "optional": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -4703,17 +4710,20 @@ "code-point-at": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "concat-map": { "version": "0.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "console-control-strings": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "core-util-is": { "version": "1.0.2", @@ -4830,7 +4840,8 @@ "inherits": { "version": "2.0.4", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "ini": { "version": "1.3.5", @@ -4842,6 +4853,7 @@ "version": "1.0.0", "bundled": true, "dev": true, + "optional": true, "requires": { "number-is-nan": "^1.0.0" } @@ -4856,6 +4868,7 @@ "version": "3.0.4", "bundled": true, "dev": true, + "optional": true, "requires": { "brace-expansion": "^1.1.7" } @@ -4863,12 +4876,14 @@ "minimist": { "version": "1.2.5", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "minipass": { "version": "2.9.0", "bundled": true, "dev": true, + "optional": true, "requires": { "safe-buffer": "^5.1.2", "yallist": "^3.0.0" @@ -4887,6 +4902,7 @@ "version": "0.5.3", "bundled": true, "dev": true, + "optional": true, "requires": { "minimist": "^1.2.5" } @@ -4948,7 +4964,8 @@ "npm-normalize-package-bin": { "version": "1.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "npm-packlist": { "version": "1.4.8", @@ -4976,7 +4993,8 @@ "number-is-nan": { "version": "1.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "object-assign": { "version": "4.1.1", @@ -4988,6 +5006,7 @@ "version": "1.4.0", "bundled": true, "dev": true, + "optional": true, "requires": { "wrappy": "1" } @@ -5101,6 +5120,7 @@ "version": "1.0.2", "bundled": true, "dev": true, + "optional": true, "requires": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", @@ -5912,7 +5932,7 @@ "lodash": "^4.17.10", "mute-stream": "0.0.7", "run-async": "^2.2.0", - "rxjs": "6.3.3", + "rxjs": "^6.1.0", "string-width": "^2.1.0", "strip-ansi": "^4.0.0", "through": "^2.3.6" diff --git a/cds-ui/designer-client/package-lock.json b/cds-ui/designer-client/package-lock.json index 699313373..540f2e93e 100644 --- a/cds-ui/designer-client/package-lock.json +++ b/cds-ui/designer-client/package-lock.json @@ -2690,7 +2690,7 @@ "lodash": "^4.17.15", "mute-stream": "0.0.8", "run-async": "^2.4.0", - "rxjs": "6.5.4", + "rxjs": "^6.5.3", "string-width": "^4.1.0", "strip-ansi": "^6.0.0", "through": "^2.3.6" diff --git a/cds-ui/server/README.md b/cds-ui/server/README.md index 5591df002..d9618d4f5 100644 --- a/cds-ui/server/README.md +++ b/cds-ui/server/README.md @@ -1,4 +1,4 @@ -/* + # cds-ui-server [![LoopBack](https://github.com/strongloop/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)-@2x.png)](http://loopback.io/) + +This service provides the backend for the CDS Designer UI. In order to function correctly, you will also need to make the `cds-blueprints-processor` service available on `localhost:8080`. +## Development +You can launch the service with +```sh +npm start +``` \ No newline at end of file -- 2.16.6