Skip to content

Commit

Permalink
chore(docs):[#511] cleanup and unify installation instructions in INS…
Browse files Browse the repository at this point in the history
…TALL.md
  • Loading branch information
ds-jhartmann committed Jul 23, 2024
1 parent 4f75b50 commit 75b6548
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 252 deletions.
36 changes: 30 additions & 6 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,38 @@
# 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).

## Installation Instructions Backend
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".

- [Installation Instructions Backend](tx-backend/INSTALL.md)
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

Expand Down Expand Up @@ -56,8 +82,6 @@ helm install umbrella charts/umbrella/ -n umbrella --create-namespace -f charts/

### Local Frontend with Umbrella Trace-X backend

To use the frontend locally, follow the [installation instructions](frontend/INSTALL.md).

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:
Expand All @@ -71,4 +95,4 @@ Afterward, use one of the following users to log into the CX-Operator realm:
### Out of scope

- Sending notifications is currently not supported
- IRS Asset Sync requires a new release of IRS which provides a fix for callback url validation
- 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.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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).

Expand Down
145 changes: 0 additions & 145 deletions frontend/INSTALL.md

This file was deleted.

93 changes: 0 additions & 93 deletions tx-backend/INSTALL.md

This file was deleted.

0 comments on commit 75b6548

Please sign in to comment.