Merge pull request #1268 from eclipse-tractusx/feature/511-local-deve…

…lopment-setup

Feature/511 local development setup

CHANGELOG.md

@@ -20,6 +20,9 @@ _**For better traceability add the corresponding GitHub issue number in each cha
 - #1244 upgraded registry from 0.4.1 to 0.5.0
 - #XXX update e2e-tests-xray_frontend.yml to support association int environment
 
+### Added
+- #511 Added installation guide for local frontend with umbrella chart
+
 ## [13.0.0 - 19.07.2024]
 
 ### Added

INSTALL.md

@@ -1,9 +1,124 @@
 # 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/charts/dev
+```
+
+```
+# 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)
+### Prerequisites
+
+* [Node.js 18](https://nodejs.org/en)
+* [Angular CLI](https://angular.io/cli)
+* [YARN](https://yarnpkg.com/)
+
+### Getting started
+
+Clone the source locally:
+
+```bash
+$ git clone [email protected]:eclipse-tractusx/traceability-foss.git
+$ cd traceability-foss/frontend
+```
+
+#### Install prerequisites:
+
+install [node.js](https://nodejs.org/en/download/package-manager)
+```bash
+$ npm install --global yarn
+$ npm install -g @angular/cli
+$ yarn install
+```
+
+Start application with ``yarn start`` and navigate to ``http://localhost:4200``.
+
+To run the frontend locally with an 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 | [email protected] | tractusx-umbr3lla!-supervisor |
+| Admin      | [email protected]      | tractusx-umbr3lla!-admin      |
+| User       | [email protected]       | tractusx-umbr3lla!-user       |
 
-## Installation Instructions Backend
+### Out of scope
 
-- [Installation Instructions Backend](tx-backend/INSTALL.md)
+- Sending/receiving of quality notifications is not supported, since it would require another tracex instance.
+- 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

@@ -20,24 +20,19 @@ A high level of transparency across the supplier network enables faster interven
   - [Introduction](#introduction)
     - [Vision and Mission Statement](#vision-and-mission-statement)
     - [Trace-X Feature list](#trace-x-feature-list)
+  - [Installation](#installation)
   - [How to contribute](#how-to-contribute)
   - [Releasing](#releasing)
-  - [Environments](#environments)
   - [Frontend Application](#frontend-application)
     - [Challenges and solutions](#challenges-and-solutions)
-    - [Prerequisites](#frontend-prerequisites)
-    - [Installation](#frontend-installation)
-    - [Getting started](#getting-started)
     - [Application authentication](#application-authentication)
     - [Application architecture & patterns](#application-architecture--patterns)
     - [User guide](#user-guide)
     - [Frontend Testing strategy](#frontend-testing-strategy)
-  - [The backend application](#the-backend-application)
+  - [The backend application](#backend-application)
     - [Prerequisites](#backend-prerequisites)
-    - [Installation](#backend-installation)
     - [Backend Testing strategy](#backend-testing-strategy)
   - [API documentation](#api-documentation)
-  - [Container Image](#container-image)
   - [Licenses](#licenses)
   - [Notice for Docker image](#notice-for-docker-image)
   - [Contact](#contact)
@@ -78,6 +73,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).
@@ -105,36 +104,6 @@ Our first approach was to use HTML canvas. But it turned out it is hard to perfo
 D3.js is a JavaScript library for manipulating documents based on data. D3 helps you bring data to life using HTML, SVG, and CSS.
 Because it uses SVGs, we knew it will perform great. And we are able to have pinpoint accuracy when it comes to user actions.
 
-### Frontend Prerequisites
-
-* [Node.js 18](https://nodejs.org/en)
-* [Angular CLI](https://angular.io/cli)
-* [YARN](https://yarnpkg.com/)
-
-### Frontend Installation
-
-* see [Installation guide](frontend/INSTALL.md)
-
-### Getting started
-
-Clone the source locally:
-
-```bash
-$ git clone [email protected]:eclipse-tractusx/traceability-foss.git
-$ cd traceability-foss/frontend
-```
-
-#### Install prerequisites:
-
-install [node.js](https://nodejs.org/en/download/package-manager)
-```bash
-$ npm install --global yarn
-$ npm install -g @angular/cli
-$ yarn install
-```
-
-Start application with ``yarn start`` and navigate to ``http://localhost:4200``.
-
 ### Application Authentication
 
 Please find [here](frontend/AUTHENTICATION.md) some important information about the app authentication.
@@ -146,7 +115,7 @@ so that you end up with a well-structured app.
 
 ### User Guide
 
-A detailed [explanation](docs/user/user-manual.adoc) of how to use the application.
+A detailed [explanation](docs/src/docs/user/user-manual.adoc) of how to use the application.
 
 ### Frontend Testing Strategy
 See [Testing](frontend/TESTING.md).
@@ -158,10 +127,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).