You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,8 +25,8 @@ This variable points to the desired api
25
25
This variable is used to set the base path of the application. (Should be set if application runs as a subtopic)
26
26
27
27
`CATENAX_PORTAL_BACKEND_DOMAIN`
28
-
This variable is needed for security, to be more explicit, for the security headers of a request.
29
-
The domain of the corresponding backend should be used here.
28
+
This variable is needed for security, to be more explicit, for the security headers of a request.
29
+
The domain of the corresponding backend should be used here.
30
30
An example value could be: `catena-x.net`
31
31
32
32
# Helm deployment
@@ -52,13 +52,13 @@ ingress:
52
52
cert-manager.io/cluster-issuer: letsencrypt-prod
53
53
hosts:
54
54
- host: "${FE_HOST_URL}"
55
-
paths:
55
+
paths:
56
56
- path: /
57
-
pathType: Prefix
57
+
pathType: Prefix
58
58
tls:
59
59
- hosts:
60
60
- "${FE_HOST_URL}"
61
-
secretName: "${FE_HOST_URL}-tls"
61
+
secretName: "${FE_HOST_URL}-tls"
62
62
63
63
```
64
64
@@ -129,5 +129,5 @@ The operator can set any environment variable in the container by using one or m
129
129
130
130
#### `${dockerImage}`
131
131
132
-
While not strictly a means of identifying a container, you can specify a version of an image you’d like to run the container with by adding `image[:tag]` to the command. For example, `docker run 002b3c518f5852f7fd5e9e46c0ea1ab4d76b697d33d5022af1a69e1a909645ea`.
132
+
While not strictly a means of identifying a container, you can specify a version of an image you’d like to run the container with by adding `image[:tag]` to the command. For example, `docker run 002b3c518f5852f7fd5e9e46c0ea1ab4d76b697d33d5022af1a69e1a909645ea`.
133
133
Images can be pulled [here](https://github.com/eclipse-tractusx/traceability-foss-frontend/pkgs/container/traceability-foss-frontend).
@@ -18,21 +18,21 @@ This saves costs by seamlessly tracking parts and creates trust through clearly
18
18
19
19
This application serves as a user entry point to the Catena-X network.
20
20
21
-
It's written in Typescript based on the `Angular` framework.
22
-
We decided on using Angular because of two important aspects.
23
-
Firstly, Angular comes with `strict guidelines`, which makes it harder to start working on for new developers, but for established developers it is `easy to start working with`.
24
-
Secondly, Angular `scales` perfectly in the long run. Because of the restricted possibilities and stricted guidelines it is hard to implement multiple solutions for the same problem. e.g. Storing data or routing.
21
+
It's written in Typescript based on the `Angular` framework.
22
+
We decided on using Angular because of two important aspects.
23
+
Firstly, Angular comes with `strict guidelines`, which makes it harder to start working on for new developers, but for established developers it is `easy to start working with`.
24
+
Secondly, Angular `scales` perfectly in the long run. Because of the restricted possibilities and stricted guidelines it is hard to implement multiple solutions for the same problem. e.g. Storing data or routing.
25
25
With that in mind it made sense it chose Angular for an `open source` project.
26
26
27
27
Source files are exposed statically through the NGINX web server.
28
28
TRACE-FOSS product composes of the backend and frontend repositories, backend repository can be found under [GitHub repository](https://github.com/catenax-ng/tx-traceability-foss-backend).
29
29
30
30
### Challenges and solutions
31
31
32
-
"Visualisation of traceability" is one of our most important feature, but once was one of our biggest problems.
33
-
We wanted to achieve something that is `visually pleasing`, is `easy to use` and `performs` very good in a `browser application`.
34
-
Our first approach was to use HTML canvas. But it turned out it is hard to perform accurate actions inside a canvas. That is why we decided on using the [D3 library](https://d3js.org/).
35
-
D3.js is a JavaScript library for manipulating documents based on data. D3 helps you bring data to life using HTML, SVG, and CSS.
32
+
"Visualisation of traceability" is one of our most important feature, but once was one of our biggest problems.
33
+
We wanted to achieve something that is `visually pleasing`, is `easy to use` and `performs` very good in a `browser application`.
34
+
Our first approach was to use HTML canvas. But it turned out it is hard to perform accurate actions inside a canvas. That is why we decided on using the [D3 library](https://d3js.org/).
35
+
D3.js is a JavaScript library for manipulating documents based on data. D3 helps you bring data to life using HTML, SVG, and CSS.
36
36
Because it uses SVGs, we knew it will perform great. And we are able to have pinpoint accuracy when it comes to user actions.
37
37
38
38
## Getting started
@@ -59,7 +59,7 @@ Find [here](docs/configuration.md) documentation to support you during the devel
59
59
60
60
### Setup changelog generation
61
61
62
-
Follow these instructions: [GIT-CHGLOG](https://github.com/git-chglog/git-chglog#installation)
62
+
Follow these instructions: [GIT-CHGLOG](https://github.com/git-chglog/git-chglog#installation)
63
63
You can generate a changelog when running `git-chglog -o CHANGELOG.md`
64
64
65
65
## Application authentication
@@ -185,16 +185,16 @@ All done!
185
185
186
186
## How to contribute
187
187
188
-
TBD
188
+
TBD
189
189
For now, we are following the angular guidelines which can be found here: [Angulars how to contribute](https://github.com/angular/angular-cli/blob/main/CONTRIBUTING.md)
190
190
191
191
## Branching system and release workflow
192
192
193
193
We are using the [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow) for our branching system.
194
194
195
-
The general idea behind this approach is that you keep the main code in a constant deployable state.
196
-
You start off with the main branch, then a developer creates a feature branch directly from main.
197
-
After the feature is developed the code is reviewed and tested on the branch.
195
+
The general idea behind this approach is that you keep the main code in a constant deployable state.
196
+
You start off with the main branch, then a developer creates a feature branch directly from main.
197
+
After the feature is developed the code is reviewed and tested on the branch.
198
198
Only after the code is stable it can be merged to main.
0 commit comments