Define schema attribute in catalog-fe angular-cli.json to have IDE autocompletion... 57/139857/2
authorFiete Ostkamp <Fiete.Ostkamp@telekom.de>
Tue, 7 Jan 2025 10:10:32 +0000 (11:10 +0100)
committerFiete Ostkamp <Fiete.Ostkamp@telekom.de>
Tue, 7 Jan 2025 11:24:15 +0000 (12:24 +0100)
- adjust angular-cli.json
- pin cypress version in package.json
- format README

Issue-ID: SDC-4709
Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>
Change-Id: Ifb1289fb5b1b18d05d7549918b79be155063a5b0

catalog-ui/README.md
catalog-ui/angular-cli.json
catalog-ui/package.json

index 9892af9..7657dc4 100644 (file)
@@ -1,11 +1,11 @@
-# CatalogUi
+# Catalog-ui
 
 ## Development server
+
 1. Run `npm start` for a dev server.
 2. Navigate to <http://localhost:9000/>.
    * The app will automatically reload if you change any of the source files.
 
-
 To Specify the user role:
 
 `npm start --env.role designer`
@@ -14,49 +14,57 @@ To Specify the user role:
 
 
 ## Build
-### dev 
-Run `npm run build` to build the project. 
 
-The build artifacts will be stored in the `dist/` directory. 
+### dev
 
+Run `npm run build` to build the project.
+The build artifacts will be stored in the `dist/` directory.
 
 ### prod
-Run `npm run build:prod` to build the project. 
 
-The build artifacts will be stored in the `dist/` directory. 
+Run `npm run build:prod` to build the project.
+The build artifacts will be stored in the `dist/` directory.
 
 ## Configuration
 
 ### webpack.server.js
+
 Development server is configured in `/webpack.server.js` file. Configure the constants accordingly:
-- const __devPort__: the webpack server port;
-- const __feHost__: the catalog front-end container host;
-- const __fePort__: the catalog front-end container port.
+- `devPort`: the webpack server port;
+- `feHost`: the catalog front-end container host;
+- `fePort`: the catalog front-end container port.
+
+For example:
+
+```js
+const fePort = 443;
+const feHost = "sdc-fe-ui.example.com";
+const protocol="https";
+```
 
-The server will create a proxy to the front end calls based on the  __feHost__ and __fePort__. 
+The server will create a proxy to the front end calls based on the  __feHost__ and __fePort__.
 
-It will also create authorization cookies to those requests. The cookies and user information comes from the 
+It will also create authorization cookies to those requests. The cookies and user information comes from the
 `/configurations/mock.json` file under the nodes `sdcConfig.cookie` and `sdcConfig.userTypes` respectively.
 
 The default user role is the node `sdcConfig.userTypes.designer` (configurable with the npm parameter --env.role).
 
 
 ### Application Configuration
-Application configuration `dev.js` or `prod.js` and `menu.js` are located in `/configuration` folder and required by `app.ts` according to __ENV__ parameter from webpack.
 
+Application configuration `dev.js` or `prod.js` and `menu.js` are located in `/configuration` folder and required by `app.ts` according to __ENV__ parameter from webpack.
 
 
 ## Running unit tests
+
 Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
 ## Running end-to-end tests
-Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
 
-Before running the tests make sure you are serving the app via `ng serve`.
+Run `npm run cypress` or `npm run cypress-headless` to execute the end-to-end tests via [Cypress](https://www.cypress.io/).
 
-## Working with WebStorm  
+## Working with WebStorm
 
 1. go to File --> Settings --> Languages & Frameworks
 2. Under JavaScript -> set JavaScript language version to ECMAScript6
 3. Under TypeScript -> select `Enable TypeScript Compiler` and choose `Use tsconfige.json`
-
index 9ec0554..5ea8989 100644 (file)
@@ -1,4 +1,5 @@
 {
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
   "project": {
     "name": "SDC APP",
     "ejected": true
index 27bba58..a153dd4 100644 (file)
@@ -18,7 +18,7 @@
     "pree2e": "webdriver-manager update --standalone false --gecko false --quiet",
     "test": "jest --coverage",
     "test:watch": "jest --watch",
-    "cypress": "cypress run",
+    "cypress": "npx cypress run",
     "cypress-headless": "start-server-and-test start http-get://localhost:9000 cypress"
   },
   "jest": {
@@ -52,6 +52,7 @@
     "copy-webpack-plugin": "^4.0.1",
     "cors": "2.7.1",
     "css-loader": "^0.26.1",
+    "cypress": "^9.7.0",
     "exports-loader": "^0.6.3",
     "express": "^4.14.0",
     "extract-text-webpack-plugin": "^2.1.0",