Merge pull request #8 from catenax-ng/release/v0.4.4

Release/v0.4.4: Style guidelines and Documentation

.github/workflows/publish-consumer-backend-docker-images.yml

@@ -21,6 +21,7 @@ name: "Publish Consumer Backend Docker Images"
 
 on:
   push:
+
     branches: [ "main", "develop" ]
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+'
@@ -34,6 +35,7 @@ env:
 
 jobs:
   build:
+
     runs-on: ubuntu-latest
     permissions:
       packages: write

.github/workflows/publish-consumer-ui-docker-images.yml

@@ -32,6 +32,7 @@ env:
 
 jobs:
   build:
+
     runs-on: ubuntu-latest
     permissions:
       packages: write

CHANGELOG.md

@@ -20,7 +20,24 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 
 ## [released]
 
-## [0.4.3] - 17/02/2023 
+## [0.4.4] - 2023-02-27 
+
+## Updated
+- Reworked header component and styles to match portal
+- Reworked footer component and styles to match portal
+- Reworked search input and styles to match portal
+- Updated image repository for consumer-ui and consumer-backend helm deployments
+- Reworked table component and styles to match portal
+
+## Added
+- Refactored SCSS styles structure, allowing a optimized scalability from the application
+- Updated frontend dependencies file.
+- Matched portal styles to pass quality gate 5
+- Refactored responsiveness from components
+- Important Documentation related with the product and repository
+
+
+## [0.4.3] - 2023-02-17 
 
 ## Updated
 - Fixed Swagger UI documentation (updated to correct one)
@@ -30,4 +47,16 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 - Fixed Import Bugs related with integration
 
 ## Security Issues:
-- Removed Keycloak Library vulnerability 
+- Removed Keycloak Library vulnerability 
+
+
+## [0.4.2] - 2023-02-05
+### Added
+- Deployment refactored to fit and follow new guidelines from DevSecOps team.
+- Data soverenity printing the contract id
+- Tractus-X Ready code 
+
+### Updated
+- Optimized the reponsive from the application
+- Optimized the passport display
+- Updated components with Vuetify 3, making the application more stable. 

CODE_OF_CONDUCT.md

@@ -1,3 +1,19 @@
+<!--
+ Copyright 2023 BASF SE, BMW AG, Henkel AG & Co. KGaA
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
 # Community Code of Conduct
 
 **Version 1.2  

CONTRIBUTING.md

@@ -1,3 +1,20 @@
+<!--
+ Copyright 2023 BASF SE, BMW AG, Henkel AG & Co. KGaA
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+
 # Contributing to Eclipse Tractus-X
 
 Thanks for your interest in this project.

DEPENDENCIES_BACKEND

@@ -8,7 +8,6 @@ maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jdk8/2.14.1,
 maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/2.14.1, Apache-2.0, approved, #4699
 maven/mavencentral/com.fasterxml.jackson.module/jackson-module-parameter-names/2.14.1, Apache-2.0, approved, #5938
 maven/mavencentral/com.github.stephenc.jcip/jcip-annotations/1.0-1, Apache-2.0, approved, CQ21949
-maven/mavencentral/com.github.ua-parser/uap-java/1.5.2, Apache-2.0, approved, clearlydefined
 maven/mavencentral/com.google.code.findbugs/jsr305/3.0.2, Apache-2.0, approved, #20
 maven/mavencentral/com.google.code.gson/gson/2.10, Apache-2.0, approved, #6159
 maven/mavencentral/com.google.errorprone/error_prone_annotations/2.11.0, Apache-2.0, approved, clearlydefined
@@ -22,9 +21,7 @@ maven/mavencentral/com.nimbusds/lang-tag/1.7, Apache-2.0, approved, clearlydefin
 maven/mavencentral/com.nimbusds/nimbus-jose-jwt/9.24.4, Apache-2.0, approved, clearlydefined
 maven/mavencentral/com.nimbusds/oauth2-oidc-sdk/9.43.1, Apache-2.0, approved, clearlydefined
 maven/mavencentral/com.opencsv/opencsv/5.7.1, Apache-2.0, approved, clearlydefined
-maven/mavencentral/com.sun.activation/jakarta.activation/1.2.2, EPL-2.0 OR BSD-3-Clause OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.jaf
 maven/mavencentral/commons-beanutils/commons-beanutils/1.9.4, Apache-2.0, approved, CQ12654
-maven/mavencentral/commons-codec/commons-codec/1.15, Apache-2.0 AND BSD-3-Clause AND LicenseRef-Public-Domain, approved, CQ22641
 maven/mavencentral/commons-collections/commons-collections/3.2.2, Apache-2.0, approved, CQ10385
 maven/mavencentral/commons-lang/commons-lang/2.6, Apache-2.0, approved, CQ6183
 maven/mavencentral/commons-logging/commons-logging/1.2, Apache-2.0, approved, CQ10162
@@ -41,7 +38,7 @@ maven/mavencentral/io.netty/netty-common/4.1.87.Final, Apache-2.0 AND MIT AND CC
 maven/mavencentral/io.netty/netty-handler-proxy/4.1.87.Final, Apache-2.0 AND BSD-3-Clause AND MIT, approved, CQ20926
 maven/mavencentral/io.netty/netty-handler/4.1.87.Final, Apache-2.0 AND BSD-3-Clause AND MIT, approved, CQ20926
 maven/mavencentral/io.netty/netty-resolver-dns-classes-macos/4.1.87.Final, Apache-2.0, approved, #6367
-maven/mavencentral/io.netty/netty-resolver-dns-native-macos/4.1.87.Final, , restricted, clearlydefined
+maven/mavencentral/io.netty/netty-resolver-dns-native-macos/4.1.87.Final, Apache-2.0, approved, clearlydefined
 maven/mavencentral/io.netty/netty-resolver-dns/4.1.87.Final, Apache-2.0 AND BSD-3-Clause AND MIT, approved, CQ20926
 maven/mavencentral/io.netty/netty-resolver/4.1.87.Final, Apache-2.0 AND BSD-3-Clause AND MIT, approved, CQ20926
 maven/mavencentral/io.netty/netty-transport-classes-epoll/4.1.87.Final, Apache-2.0, approved, #6366
@@ -64,8 +61,6 @@ maven/mavencentral/net.minidev/json-smart/2.4.8, Apache-2.0, approved, #3288
 maven/mavencentral/org.apache.commons/commons-collections4/4.4, Apache-2.0, approved, clearlydefined
 maven/mavencentral/org.apache.commons/commons-lang3/3.12.0, Apache-2.0, approved, clearlydefined
 maven/mavencentral/org.apache.commons/commons-text/1.10.0, Apache-2.0, approved, clearlydefined
-maven/mavencentral/org.apache.httpcomponents/httpclient/4.5.14, Apache-2.0 AND LicenseRef-Public-Domain, approved, CQ23527
-maven/mavencentral/org.apache.httpcomponents/httpcore/4.4.16, Apache-2.0, approved, CQ23528
 maven/mavencentral/org.apache.logging.log4j/log4j-api/2.19.0, Apache-2.0, approved, clearlydefined
 maven/mavencentral/org.apache.logging.log4j/log4j-core/2.19.0, Apache-2.0 AND (Apache-2.0 AND LGPL-2.0-or-later), approved, #5009
 maven/mavencentral/org.apache.logging.log4j/log4j-to-slf4j/2.19.0, Apache-2.0, approved, #5941
@@ -74,24 +69,10 @@ maven/mavencentral/org.apache.tomcat.embed/tomcat-embed-el/10.1.5, Apache-2.0, a
 maven/mavencentral/org.apache.tomcat.embed/tomcat-embed-websocket/10.1.5, Apache-2.0, approved, clearlydefined
 maven/mavencentral/org.atteo/evo-inflector/1.3, Apache-2.0, approved, clearlydefined
 maven/mavencentral/org.bouncycastle/bcpkix-jdk15on/1.69, MIT, approved, clearlydefined
-maven/mavencentral/org.bouncycastle/bcprov-jdk15on/1.70, MIT, approved, #1712
+maven/mavencentral/org.bouncycastle/bcprov-jdk15on/1.69, MIT, approved, clearlydefined
 maven/mavencentral/org.bouncycastle/bcutil-jdk15on/1.69, MIT, approved, clearlydefined
 maven/mavencentral/org.checkerframework/checker-qual/3.12.0, MIT, approved, clearlydefined
 maven/mavencentral/org.codehaus.plexus/plexus-utils/3.2.1, , approved, CQ20774
-maven/mavencentral/org.jboss.logging/jboss-logging/3.5.0.Final, Apache-2.0, approved, clearlydefined
-maven/mavencentral/org.keycloak/keycloak-adapter-core/20.0.0, Apache-2.0, approved, clearlydefined
-maven/mavencentral/org.keycloak/keycloak-adapter-spi/20.0.0, Apache-2.0, approved, #6338
-maven/mavencentral/org.keycloak/keycloak-authz-client/20.0.0, Apache-2.0, approved, #6339
-maven/mavencentral/org.keycloak/keycloak-common/20.0.0, Apache-2.0, approved, clearlydefined
-maven/mavencentral/org.keycloak/keycloak-core/20.0.0, Apache-2.0, approved, #6337
-maven/mavencentral/org.keycloak/keycloak-crypto-default/20.0.0, Apache-2.0, approved, #6340
-maven/mavencentral/org.keycloak/keycloak-server-spi-private/20.0.0, Apache-2.0, approved, clearlydefined
-maven/mavencentral/org.keycloak/keycloak-server-spi/20.0.0, Apache-2.0, approved, clearlydefined
-maven/mavencentral/org.keycloak/keycloak-spring-boot-2-adapter/20.0.0, Apache-2.0, approved, clearlydefined
-maven/mavencentral/org.keycloak/keycloak-spring-boot-adapter-core/20.0.0, Apache-2.0, approved, #6342
-maven/mavencentral/org.keycloak/keycloak-spring-boot-starter/20.0.3, , restricted, clearlydefined
-maven/mavencentral/org.keycloak/keycloak-spring-security-adapter/20.0.3, Apache-2.0, approved, #6344
-maven/mavencentral/org.keycloak/spring-boot-container-bundle/20.0.0, Apache-2.0, approved, #6343
 maven/mavencentral/org.ow2.asm/asm/9.1, BSD-3-Clause, approved, CQ23029
 maven/mavencentral/org.reactivestreams/reactive-streams/1.0.4, CC0-1.0, approved, CQ16332
 maven/mavencentral/org.slf4j/jul-to-slf4j/2.0.6, MIT, approved, clearlydefined
@@ -122,7 +103,7 @@ maven/mavencentral/org.springframework.cloud/spring-cloud-starter/3.1.5, Apache-
 maven/mavencentral/org.springframework.data/spring-data-commons/3.0.1, Apache-2.0, approved, #5943
 maven/mavencentral/org.springframework.data/spring-data-rest-core/4.0.1, Apache-2.0, approved, clearlydefined
 maven/mavencentral/org.springframework.data/spring-data-rest-webmvc/4.0.1, Apache-2.0, approved, clearlydefined
-maven/mavencentral/org.springframework.hateoas/spring-hateoas/2.0.1, Apache-2.0, restricted, clearlydefined
+maven/mavencentral/org.springframework.hateoas/spring-hateoas/2.0.1, Apache-2.0, approved, #7167
 maven/mavencentral/org.springframework.plugin/spring-plugin-core/3.0.0, Apache-2.0, approved, #7104
 maven/mavencentral/org.springframework.security/spring-security-config/6.0.1, Apache-2.0, approved, clearlydefined
 maven/mavencentral/org.springframework.security/spring-security-core/6.0.1, Apache-2.0, approved, clearlydefined

DEPENDENCIES_FRONTEND

@@ -428,4 +428,4 @@ npm/npmjs/@vue/runtime-core/3.2.47, MIT, approved, #7086
 npm/npmjs/@vue/runtime-dom/3.2.47, MIT, approved, #7099
 npm/npmjs/@vue/server-renderer/3.2.47, MIT, approved, #3105
 npm/npmjs/@vue/shared/3.2.47, MIT, approved, #7090
-npm/npmjs/@vuetify/loader-shared/1.7.1, MIT, approved, #6949
+npm/npmjs/@vuetify/loader-shared/1.7.1, MIT, approved, #6949

NOTICE.md

@@ -1,3 +1,20 @@
+<!--
+ Copyright 2023 BASF SE, BMW AG, Henkel AG & Co. KGaA
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+
 # Notices for Eclipse Tractus-X
 
 This content is produced and maintained by the Eclipse Tractus-X project.

README.md

@@ -14,22 +14,35 @@
  limitations under the License.
 -->
 
-# ![Product Battery Passport Consumer Application (Frontend)](./docs/catena-x-logo.svg) Product Battery Passport Consumer App (Frontend)
+# ![Digital Product Passport Consumer Application (Frontend)](./docs/catena-x-logo.svg) Digital Product Passport Consumer App (Frontend)
 
-## What is battery passport consumer application?
+## What is digital product passport consumer application?
 
-The battery passport consumer application provides a user interface to request a battery passport from a battery manufacturer using the standardized components and technologies in a Catena-X network. The passport will be displayed in a human-readable from any browser. The data exchange standards given by Catena-X are used to provide the battery passport to different personas (roles) in the network.
+The digital product passport consumer application provides a user interface to request a battery passport from a battery manufacturer using the standardized components and technologies in a Catena-X network. The passport will be displayed in a human-readable from any browser. The data exchange standards given by Catena-X are used to provide the battery passport to different personas (roles) in the network.
 
-In particular, the appliction is used to access the battery passport data provided by battery manufacturer. By scanning QR-code or knowing the manufacturer and battery-ID, a user can request the passport  through **Eclipse Dataspace Connectors (EDCs)** over the Catena-X network. The passport provider will provide data attributes that is only visible to a permitted signed-in user. A Guide for End Users can be found here: [End User Manual](./docs/user%20manual/User%20Manual%20Product%20Viewer%20App.md)
+In particular, the appliction is used to access the battery passport data provided by battery manufacturer. By scanning QR-code or knowing the manufacturer and battery-ID, a user can request the passport  through **Eclipse Dataspace Connectors (EDCs)** over the Catena-X network. The passport provider will provide data attributes that is only visible to a permitted signed-in user. 
 
 
 ## Getting Started
 
-Before contributing please read:
-- [Community Code of Conduct](./docs/tractusx/CODE_OF_CONDUCT.md)
-- [Contributing Guidelines](./docs/tractusx/CONTRIBUTING.md)
-- [Notice on tractus-x Repositories](./docs/tractusx/NOTICE_template.md)
-- [Security Policy](./docs/tractusx/SECURITY.md)
+To get Started you can have a look into our documentation:
+
+| Name                                                                      | Description                                                                                                                                                        |
+| ----------------------------------------------------------------          | -----------------------------------------------------------------------------------------------------------------------------------------------------------        |
+| [Arc42](\docs\arc42\Arc42.md)                                             | Arc42 of Digital Product Pass                                                                                                                                      |
+| [Administration Guide](\docs\admin%20guide\Admin_Guide.md)                  | Backend documentation Product Passport App                                                                                                                         |
+| [Backend Documentation](\consumer-backend\productpass\readme.md)          | Backend documentation Product Passport App                                                                                                                         |
+| [Deployment in Hotel Budapest](\deployment\README.md)                     | Technical Guide - Deployment in ArgoCD Hotel Budapest (integration environment)                                                                                    |
+| [Docker Overview](\docker\README.md)                                      | Overview on general docker commands                                                                                                                                |
+| [Keycloak Overview](\docker\local\Keycloak\README.md)                     | This guide describes how to setup a keycloak instance in local docker container and import existing realm.json file.                                               |
+| [Short Introduction into the project](\docs\GETTING-STARTED.md)           | Battery Pass Allpication infrastructure, installation guide, technical usage guide                                                                                 |
+| [Code Scaning with Kics and Trivy](\docs\IaC.md)                          | Infrastructure As Code (IaC) with KICS intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github        |
+| [Release Guideance](\docs\RELEASE.md)                                     | Product Battery Pass Consumer App Release Guide                                                                                                                    |
+| [Secret Management](\docs\SECRETS-MANAGEMENT.md)                          | Secrets management with CX HashiCorp Vault and ArgoCD Vault Plugin (AVP) - client credentials, database passwords, access tokens                                   |
+| [Cypress Overview](\docs\cypress\CYPRESS.md)                              | Documentation for Battery Passport App E2E Cypress test                                                                                                            |
+| [End User Manual](\User%20Manual%20Product%20Viewer%20App.md)             | Enduser Manual Product Viewer App                                                                                                                                  |
+| [Postman Overview](\postman\README.md)                                    | Technical guide depicts the battery pass end-to-end API calls through the postman REST client                                                                      |
+| [Changelog](\CHANGELOG.md)                                                | Changelog                                                                                                                                                          |
 
 ### Prerequisites:
 
@@ -44,7 +57,7 @@ Before contributing please read:
 ### Clone project repository
 
 ```bash
-git clone https://github.com/catenax-ng/product-battery-passport-consumer-app.git
+git clone https://github.com/eclipse-tractusx/digital-product-pass.git
 ```
 
 ### Install dependencies
@@ -88,16 +101,16 @@ docker stop consumer-ui; docker rm consumer-ui;
 ```
 You can run the application in docker container with existing image from GitHub packages.
 
-See consumer frontend docker image in registry: [consumer-ui](https://github.com/catenax-ng/product-battery-passport-consumer-app/pkgs/container/product-battery-passport-consumer-app%2Fconsumer-ui)
+See consumer frontend docker image in registry: [consumer-ui](https://github.com/eclipse-tractusx/digital-product-pass/pkgs/container/product-battery-passport-consumer-app%2Fconsumer-ui)
 
 ```bash
 # pull the image 
 # Replace placeholder <LATEST_TAG> with the most recent tag in registry
 
-docker pull ghcr.io/catenax-ng/product-battery-passport-consumer-app/consumer-ui:<LATEST_TAG>
+docker pull ghcr.io/eclipse-tractusx/digital-product-pass/consumer-ui:<LATEST_TAG>
 
 # run docker image
-docker run -p 8080:8080 --name consumer-ui -d ghcr.io/catenax-ng/product-battery-passport-consumer-app/consumer-ui:<LATEST_TAG>
+docker run -p 8080:8080 --name consumer-ui -d ghcr.io/eclipse-tractusx/digital-product-pass/consumer-ui:<LATEST_TAG>
 ```
 The consumer frontend is available in browser at [http://localhost:8080](http://localhost:8080)
 
@@ -109,4 +122,4 @@ See [VSCode configuration](https://confluence.catena-x.net/pages/viewpage.action
 
 ## License
 
-[Apache-2.0](https://raw.githubusercontent.com/catenax-ng/product-battery-passport-consumer-app/main/LICENSE)
+[Apache-2.0](https://raw.githubusercontent.com/eclipse-tractusx/digital-product-pass/digital-product-pass/main/LICENSE)