Feature/511 local development setup

CHANGELOG.md

@@ -11,6 +11,9 @@ _**For better traceability add the corresponding GitHub issue number in each cha
 - #1070 Convert png to svg according to TRG 1.04 - Diagrams as code / Editable static files
 - #xxx update IRS chart version from 7.3.1 to 7.4.0
 
+### Added
+- #511 Added installation guide for local frontend with umbrella chart
+
 ## [13.0.0 - 19.07.2024]
 
 ### Added

INSTALL.md

@@ -1,9 +1,98 @@
 # Installation Instructions
 
+## Installation Instructions Helm
+
+### Install Helm chart from the Helm chart repository
+
+```
+# 1. Add the helm chart repository:
+helm repo add tractusx-dev https://eclipse-tractusx.github.io/
+```
+
+```
+# 2. Install traceability-foss chart into your cluster:
+helm install traceability-foss tractusx-dev/traceability-foss
+```
+### Use Helm chart as dependency on your own Helm chart
+
+```
+    dependencies:
+      - name: traceability-foss
+        repository: https://eclipse-tractusx.github.io/traceability-foss
+        version: 1.x.x
+```
+
+### Configure product-example Helm chart on your needs
+
+Please have a look into our [Helm chart documentation](charts/traceability-foss/README.md) for more information about the configuration options.
+
 ## Installation Instructions Frontend
 
-- [Installation Instructions Frontend](frontend/INSTALL.md)
+To run the frontend locally with a already existing backend, use the run configs in [frontend/package.json](frontend/package.json).
+
+Add a run config by creating a new entry in [package.json](frontend/package.json) similar to `"start:auth": "ng serve --configuration=dev,auth"` and adding a entry in [angular.json](frontend/angular.json) at "projects.trace-x.architect.build.configuratns" and "projects.trace-x.architect.serve.configurations".
+
+Add an environment by creating new file in [frontend/src/environments](frontend/src/environments) and reference it in the [package.json](frontend/package.json) build configuration.
+
+## Installation Instructions Local Umbrella
+
+### Install Umbrella
+
+Using the [eclipse-tractusx/tractus-x-umbrella](https://github.com/eclipse-tractusx/tractus-x-umbrella) helm chart, all traceability-foss dependencies can be installed locally.
+
+For detailed instructions on how to set up the umbrella chart, see the chapters "Cluster setup" and "Network setup" in the umbrella [README.md](https://github.com/eclipse-tractusx/tractus-x-umbrella/blob/main/charts/umbrella/README.md).
+
+Clone the [Umbrella repo](https://github.com/eclipse-tractusx/tractus-x-umbrella) (only required once):
+
+```
+git clone https://github.com/eclipse-tractusx/tractus-x-umbrella.git
+```
+
+Check out the [Trace-X umbrella integration branch](https://github.com/eclipse-tractusx/tractus-x-umbrella/tree/chore/trace-x-integration):
+
+```
+cd tractus-x-umbrella/
+git fetch origin
+git checkout -b chore/trace-x-integration origin/chore/trace-x-integration
+```
+
+Build the required images for Idp and IATP mock.
+
+#### Powershell
+```powershell
+& minikube -p minikube docker-env --shell powershell | Invoke-Expression
+docker build init-container/ -t init-container:testing
+docker build iatp-mock/ -t tractusx/iatp-mock:testing --platform linux/amd64
+```
+
+#### Bash
+```bash
+eval $(minikube docker-env)
+docker build init-container/ -t init-container:testing
+docker build iatp-mock/ -t tractusx/iatp-mock:testing --platform linux/amd64
+```
+
+Install the umbrella chart using the [values-adopter-trace-x.yaml](https://github.com/eclipse-tractusx/tractus-x-umbrella/blob/chore/trace-x-integration/charts/umbrella/values-adopter-trace-x.yaml)
+
+```
+helm dependency update charts/tx-data-provider/
+helm dependency update charts/umbrella/
+helm install umbrella charts/umbrella/ -n umbrella --create-namespace -f charts/umbrella/values-adopter-trace-x.yaml
+```
+
+### Local Frontend with Umbrella Trace-X backend
+
+To integrate with the umbrella services, run the frontend with `start:auth:localUmbrella`
+
+Afterward, use one of the following users to log into the CX-Operator realm:
+
+| Role       | Username                  | Password                      |
+|------------|---------------------------|-------------------------------|
+| Supervisor | tracex-supervisor@tx.test | tractusx-umbr3lla!-supervisor |
+| Admin      | tracex-admin@tx.test      | tractusx-umbr3lla!-admin      |
+| User       | tracex-user@tx.test       | tractusx-umbr3lla!-user       |
 
-## Installation Instructions Backend
+### Out of scope
 
-- [Installation Instructions Backend](tx-backend/INSTALL.md)
+- Sending notifications is currently not supported
+- IRS Asset Sync does not yet work with IRS 5.4.0. It requires a new release of IRS which provides a fix for callback url validation.

README.md

@@ -78,6 +78,10 @@ Trace-X as the Open-Source solution for Parts Traceability offers the following
   * Quality Investigations (Company to Supplier)
   * Quality Alerts (Company to Customers)
 
+## Installation
+
+* see [Installation guide](INSTALL.md)
+
 ## How to contribute
 
 A detailed guide on how to contribute can be found [here](CONTRIBUTING.md).
@@ -111,10 +115,6 @@ Because it uses SVGs, we knew it will perform great. And we are able to have pin
 * [Angular CLI](https://angular.io/cli)
 * [YARN](https://yarnpkg.com/)
 
-### Frontend Installation
-
-* see [Installation guide](frontend/INSTALL.md)
-
 ### Getting started
 
 Clone the source locally:
@@ -158,10 +158,6 @@ See [Testing](frontend/TESTING.md).
 * JDK 21
 * [Docker Engine](https://docs.docker.com/engine/)
 
-### Backend Installation
-
-* see [Installation guide](tx-backend/INSTALL.md)
-
 ### Backend Testing Strategy
 See [Testing](tx-backend/TESTING.md).
 

frontend/angular.json

@@ -137,6 +137,14 @@
                 }
               ]
             },
+            "localUmbrella": {
+              "fileReplacements": [
+                {
+                  "replace": "src/environments/environment.ts",
+                  "with": "src/environments/environment.localUmbrella.ts"
+                }
+              ]
+            },
             "production": {
               "fileReplacements": [
                 {
@@ -212,6 +220,9 @@
             },
             "debugProd": {
               "browserTarget": "trace-x:build:dev,debugProd"
+            },
+            "localUmbrella": {
+              "browserTarget": "trace-x:build:dev,localUmbrella"
             }
           }
         },

frontend/package.json

@@ -22,6 +22,7 @@
     "start:auth:mock": "ng serve --configuration=authMock",
     "start:auth:local": "ng serve --configuration=authLocal",
     "start:auth:localBe": "ng serve --configuration=localBackend",
+    "start:auth:localUmbrella": "ng serve --configuration=localUmbrella",
     "start:noAuth:localBe": "ng serve --configuration=localBackendNoAuth",
     "env:mock": "docker-compose up",
     "test": "ng test",