Skip to content

Commit 6022b07

Browse files
committed
chore(docs):[#1222] fix references to installation, move frontend instructions to INSTALL.md, cleanup README.md
1 parent 75651d0 commit 6022b07

File tree

2 files changed

+31
-36
lines changed

2 files changed

+31
-36
lines changed

INSTALL.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,33 @@ Please have a look into our [Helm chart documentation](charts/traceability-foss/
2828

2929
## Installation Instructions Frontend
3030

31-
To run the frontend locally with a already existing backend, use the run configs in [frontend/package.json](frontend/package.json).
31+
### Prerequisites
32+
33+
* [Node.js 18](https://nodejs.org/en)
34+
* [Angular CLI](https://angular.io/cli)
35+
* [YARN](https://yarnpkg.com/)
36+
37+
### Getting started
38+
39+
Clone the source locally:
40+
41+
```bash
42+
$ git clone [email protected]:eclipse-tractusx/traceability-foss.git
43+
$ cd traceability-foss/frontend
44+
```
45+
46+
#### Install prerequisites:
47+
48+
install [node.js](https://nodejs.org/en/download/package-manager)
49+
```bash
50+
$ npm install --global yarn
51+
$ npm install -g @angular/cli
52+
$ yarn install
53+
```
54+
55+
Start application with ``yarn start`` and navigate to ``http://localhost:4200``.
56+
57+
To run the frontend locally with an already existing backend, use the run configs in [frontend/package.json](frontend/package.json).
3258

3359
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".
3460

@@ -94,5 +120,5 @@ Afterward, use one of the following users to log into the CX-Operator realm:
94120

95121
### Out of scope
96122

97-
- Sending/receiving of quality notifications is not supported, since it would require another tracex instance.
123+
- Sending/receiving of quality notifications is not supported, since it would require another tracex instance.
98124
- 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

Lines changed: 3 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,19 @@ A high level of transparency across the supplier network enables faster interven
2020
- [Introduction](#introduction)
2121
- [Vision and Mission Statement](#vision-and-mission-statement)
2222
- [Trace-X Feature list](#trace-x-feature-list)
23+
- [Installation](#installation)
2324
- [How to contribute](#how-to-contribute)
2425
- [Releasing](#releasing)
25-
- [Environments](#environments)
2626
- [Frontend Application](#frontend-application)
2727
- [Challenges and solutions](#challenges-and-solutions)
28-
- [Prerequisites](#frontend-prerequisites)
29-
- [Installation](#frontend-installation)
30-
- [Getting started](#getting-started)
3128
- [Application authentication](#application-authentication)
3229
- [Application architecture & patterns](#application-architecture--patterns)
3330
- [User guide](#user-guide)
3431
- [Frontend Testing strategy](#frontend-testing-strategy)
35-
- [The backend application](#the-backend-application)
32+
- [The backend application](#backend-application)
3633
- [Prerequisites](#backend-prerequisites)
37-
- [Installation](#backend-installation)
3834
- [Backend Testing strategy](#backend-testing-strategy)
3935
- [API documentation](#api-documentation)
40-
- [Container Image](#container-image)
4136
- [Licenses](#licenses)
4237
- [Notice for Docker image](#notice-for-docker-image)
4338
- [Contact](#contact)
@@ -109,32 +104,6 @@ Our first approach was to use HTML canvas. But it turned out it is hard to perfo
109104
D3.js is a JavaScript library for manipulating documents based on data. D3 helps you bring data to life using HTML, SVG, and CSS.
110105
Because it uses SVGs, we knew it will perform great. And we are able to have pinpoint accuracy when it comes to user actions.
111106

112-
### Frontend Prerequisites
113-
114-
* [Node.js 18](https://nodejs.org/en)
115-
* [Angular CLI](https://angular.io/cli)
116-
* [YARN](https://yarnpkg.com/)
117-
118-
### Getting started
119-
120-
Clone the source locally:
121-
122-
```bash
123-
$ git clone [email protected]:eclipse-tractusx/traceability-foss.git
124-
$ cd traceability-foss/frontend
125-
```
126-
127-
#### Install prerequisites:
128-
129-
install [node.js](https://nodejs.org/en/download/package-manager)
130-
```bash
131-
$ npm install --global yarn
132-
$ npm install -g @angular/cli
133-
$ yarn install
134-
```
135-
136-
Start application with ``yarn start`` and navigate to ``http://localhost:4200``.
137-
138107
### Application Authentication
139108

140109
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.
146115

147116
### User Guide
148117

149-
A detailed [explanation](docs/user/user-manual.adoc) of how to use the application.
118+
A detailed [explanation](docs/src/docs/user/user-manual.adoc) of how to use the application.
150119

151120
### Frontend Testing Strategy
152121
See [Testing](frontend/TESTING.md).

0 commit comments

Comments
 (0)