Skip to content

Commit

Permalink
chore(docs):[#1222] fix references to installation, move frontend ins…
Browse files Browse the repository at this point in the history
…tructions to INSTALL.md, cleanup README.md
  • Loading branch information
ds-jhartmann committed Jul 24, 2024
1 parent 75651d0 commit 6022b07
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 36 deletions.
30 changes: 28 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,33 @@ Please have a look into our [Helm chart documentation](charts/traceability-foss/

## Installation Instructions Frontend

To run the frontend locally with a already existing backend, use the run configs in [frontend/package.json](frontend/package.json).
### 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 git@github.com: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".

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

### Out of scope

- Sending/receiving of quality notifications is not supported, since it would require another tracex instance.
- 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.
37 changes: 3 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -109,32 +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/)

### Getting started

Clone the source locally:

```bash
$ git clone git@github.com: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.
Expand All @@ -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).
Expand Down

0 comments on commit 6022b07

Please sign in to comment.