-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Chore/#1070 release checks r24.8 Preparation for release #R24.8
- Loading branch information
Showing
46 changed files
with
958 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,46 +4,51 @@ | |
| [](https://github.com/eclipse-tractusx/traceability-foss/blob/main/LICENSE_non-code) | ||
| [](https://sonarcloud.io/summary/new_code?id=eclipse-tractusx_traceability-foss-backend) | ||
| [](https://sonarcloud.io/summary/new_code?id=eclipse-tractusx_traceability-foss-frontend) | ||
| [](https://sonarcloud.io/summary/new_code?id=eclipse-tractusx_traceability-foss-backend) | ||
| [](https://sonarcloud.io/summary/new_code?id=eclipse-tractusx_traceability-foss-frontend) | ||
| [](https://github.com/eclipse-tractusx/traceability-foss/actions/workflows/kics.yml) | ||
| [](https://github.com/eclipse-tractusx/traceability-foss/actions/workflows/trivy.yml) | ||
| [](https://github.com/eclipse-tractusx/traceability-foss/actions/workflows/eclipse-dash.yml) | ||
| [![[BE] Dependency check](https://github.com/catenax-ng/tx-traceability-foss/actions/workflows/dependency-check.yml/badge.svg)](https://github.com/catenax-ng/tx-traceability-foss/actions/workflows/dependency-check.yml) | ||
|
|
||
| ## Trace-X is a system for tracking parts along the supply chain. | ||
| #### A high level of transparency across the supplier network enables faster intervention based on a recorded event in the supply chain. This saves costs by seamlessly tracking parts and creates trust through clearly defined and secure data access by the companies and persons involved in the process. | ||
|
|
||
| A high level of transparency across the supplier network enables faster intervention based on a recorded event in the supply chain. This saves costs by seamlessly tracking parts and creates trust through clearly defined and secure data access by the companies and persons involved in the process. | ||
|
|
||
| ## Table of Contents | ||
| - [Trace-X](https://github.com/eclipse-tractusx/traceability-foss/#trace-x-is-a-system-for-tracking-parts-along-the-supply-chain) | ||
| - [Trace-X](#trace-x-is-a-system-for-tracking-parts-along-the-supply-chain) | ||
| - [Introduction](#introduction) | ||
| - [Vision and Mission Statement](#vision-and-mission-statement) | ||
| - [Trace-X Feature list](#trace-x-feature-list) | ||
| - [How to contribute](https://github.com/eclipse-tractusx/traceability-foss/#how-to-contribute) | ||
| - [Releasing](https://github.com/eclipse-tractusx/traceability-foss/#releasing) | ||
| - [Environments](https://github.com/eclipse-tractusx/traceability-foss/#environments) | ||
| - [The frontend application](https://github.com/eclipse-tractusx/traceability-foss/#the-frontend-application) | ||
| - [Challenges and solutions](https://github.com/eclipse-tractusx/traceability-foss/#challenges-and-solutions) | ||
| - [Prerequisites](https://github.com/eclipse-tractusx/traceability-foss/#frontend-prerequisites) | ||
| - [Installation](https://github.com/eclipse-tractusx/traceability-foss/#frontend-installation) | ||
| - [Getting started](https://github.com/eclipse-tractusx/traceability-foss/#getting-started) | ||
| - [Application authentication](https://github.com/eclipse-tractusx/traceability-foss/#application-authentication) | ||
| - [Application architecture & patterns](https://github.com/eclipse-tractusx/traceability-foss/#application-architecture--patterns) | ||
| - [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](https://github.com/eclipse-tractusx/traceability-foss/#the-backend-application) | ||
| - [Prerequisites](https://github.com/eclipse-tractusx/traceability-foss/#backend-prerequisites) | ||
| - [Installation](https://github.com/eclipse-tractusx/traceability-foss/#backend-installation) | ||
| - [The backend application](#the-backend-application) | ||
| - [Prerequisites](#backend-prerequisites) | ||
| - [Installation](#backend-installation) | ||
| - [Backend Testing strategy](#backend-testing-strategy) | ||
| - [API documentation](https://github.com/eclipse-tractusx/traceability-foss/#api-documentation) | ||
| - [Container Image](https://github.com/eclipse-tractusx/traceability-foss/#container-image) | ||
| - [Licenses](https://github.com/eclipse-tractusx/traceability-foss/#licenses) | ||
| - [API documentation](#api-documentation) | ||
| - [Container Image](#container-image) | ||
| - [Licenses](#licenses) | ||
| - [Notice for Docker image](#notice-for-docker-image) | ||
| - [Contact](#contact) | ||
|
|
||
| ## Introduction | ||
|
|
||
| ### Vision and Mission Statement | ||
| Trace-X empowers all companies from SMEs to large OEMs to participate in parts traceability with an Open-Source solution. | ||
|
|
||
| The Open-Source Traceability application is developed within the Catena-X project and enables all companies to participate in Parts Traceability. | ||
| Trace-X offers capabilities to ingest data for serialized parts and batches as well as their child components. Within CX, we strive to establish a standardized, data-sovereign and interoperable exchange of traceability data along the value creation chain. | ||
| The Open-Source Traceability application is developed within the Catena-X project and enables all companies to participate in Parts Traceability. | ||
| Trace-X offers capabilities to ingest data for serialized parts and batches as well as their child components. Within CX, we strive to establish a standardized, data-sovereign and interoperable exchange of traceability data along the value creation chain. | ||
|
|
||
| The application gives an overview of the supplier network and the supply chain. A high level of transparency across the supplier network enables faster intervention based on recorded events in the supply chain. Additionally, automated massages regarding Quality related incidents and a tool for inspecting the supply chain helps companies in these fast-moving times. | ||
|
|
||
|
|
@@ -52,37 +57,47 @@ All this saves' costs by seamlessly tracking parts as well as creates trust thro | |
| ### Trace-X Feature list | ||
| Trace-X as the Open-Source solution for Parts Traceability offers the following functionalities: | ||
|
|
||
| * List and view manufactured parts based on BoM AsBuild | ||
| * List and view manufactured parts based on BoM AsBuilt | ||
| * List and view planned parts based on BoM AsPlanned | ||
| * Filter and Search functionality on part views | ||
| * Filter and search functionality on part views | ||
| * Show detailed information on manufactured parts | ||
| ** Asset Administration Shell description | ||
| ** Submodel description such as SerialPartTypization, AssemblyPartRelationship, Batch | ||
| * List and view Supplier parts based on BoM As Build | ||
| ** List of Supplier parts based on AssemblyPartRelationship Aspect | ||
| * Asset Administration Shell description | ||
| * Submodel description such as | ||
| * SerialPart | ||
| * SingleLevelBomAsBuilt | ||
| * SingleLevelUsageAsBuilt | ||
| * Batch | ||
| * JustInSequence | ||
| * PartAsPlanned | ||
| * SingleLevelBomAsPlanned | ||
| * SingleLevelUsageAsPlanned | ||
| * List and view Supplier parts based on BoM As Built | ||
| * List of Supplier parts based on SingleLevelBomAsBuilt/SingleLevelUsageAsBuilt Aspect | ||
| * View parts and parts relations in parts tree | ||
| * Send and receive quality investigations along the supply chain | ||
| * Quality Investigations (Company to Supplier) | ||
| * Quality Alerts (Company to Customers) | ||
|
|
||
| ## How to contribute | ||
|
|
||
| A detailed guide on how to contribute can be found [here](https://github.com/eclipse-tractusx/traceability-foss/blob/main/CONTRIBUTING.md). | ||
| A detailed guide on how to contribute can be found [here](CONTRIBUTING.md). | ||
|
|
||
| ## Releasing | ||
| Here is our [Releasing guide](https://github.com/eclipse-tractusx/traceability-foss/blob/main/docs/RELEASE.md). | ||
| Here is our [Releasing Guide](docs/RELEASE.md). | ||
|
|
||
| ## The frontend application | ||
| ## Frontend Application | ||
|
|
||
| This application serves as a user entry point to the Catena-X network. | ||
|
|
||
| It's written in Typescript based on the `Angular` framework. | ||
| It's written in Typescript based on the [Angular](https://angular.dev/) framework. | ||
| We decided on using Angular because of two important aspects. | ||
| 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`. | ||
| 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. | ||
| Secondly, Angular `scales` perfectly in the long run. Because of the restricted possibilities and strict guidelines it is hard to implement multiple solutions for the same problem. e.g. Storing data or routing. | ||
| With that in mind it made sense it chose Angular for an `open source` project. | ||
|
|
||
| Source files are exposed statically through the NGINX web server. | ||
|
|
||
| ### Challenges and solutions | ||
| ### Challenges and Solutions | ||
|
|
||
| "Visualisation of traceability" is one of our most important feature, but once was one of our biggest problems. | ||
| We wanted to achieve something that is `visually pleasing`, is `easy to use` and `performs` very good in a `browser application`. | ||
|
|
@@ -98,44 +113,44 @@ Because it uses SVGs, we knew it will perform great. And we are able to have pin | |
|
|
||
| ### Frontend Installation | ||
|
|
||
| * see [Installation guide](https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/INSTALL.md) | ||
| * see [Installation guide](frontend/INSTALL.md) | ||
|
|
||
| ### Getting started | ||
|
|
||
| Clone the source locally: | ||
|
|
||
| ```sh | ||
| ```bash | ||
| $ git clone [email protected]:eclipse-tractusx/traceability-foss.git | ||
| $ cd traceability-foss/frontend | ||
| ``` | ||
|
|
||
| Install prerequisites: | ||
| 1. install [node.js](https://nodejs.org/en/download/package-manager) | ||
| ```sh | ||
| ```bash | ||
| $ npm install --global yarn | ||
| $ npm install -g @angular/cli | ||
| $ yarn install | ||
| ``` | ||
|
|
||
| Start application with``yarn start`` and navigate to ``http://localhost:4200``. | ||
| Start application with ``yarn start`` and navigate to ``http://localhost:4200``. | ||
|
|
||
| ### Application authentication | ||
| ### Application Authentication | ||
|
|
||
| Please find [here](https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/AUTHENTICATION.md) some important information about the app authentication. | ||
| Please find [here](frontend/AUTHENTICATION.md) some important information about the app authentication. | ||
|
|
||
| ### Application architecture & patterns | ||
| ### Application Architecture & Patterns | ||
|
|
||
| This [architecture](https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/ARCHITECTURE.md) gives you a roadmap and best practices to follow when building an application | ||
| This [architecture](frontend/ARCHITECTURE.md) gives you a roadmap and best practices to follow when building an application | ||
| so that you end up with a well-structured app. | ||
|
|
||
| ### User guide | ||
| ### User Guide | ||
|
|
||
| A detailed [explanation](https://github.com/eclipse-tractusx/traceability-foss/blob/main/docs/src/docs/user/user-manual.adoc) of how to use the application. | ||
| A detailed [explanation](docs/user/user-manual.adoc) of how to use the application. | ||
|
|
||
| ### Frontend Testing Strategy | ||
| See [TESTING](frontend/TESTING.md). | ||
|
|
||
| ## The backend application | ||
| ## Backend Application | ||
|
|
||
| ### Backend Prerequisites | ||
|
|
||
|
|
@@ -144,26 +159,26 @@ See [TESTING](frontend/TESTING.md). | |
|
|
||
| ### Backend Installation | ||
|
|
||
| * see [Installation guide](https://github.com/eclipse-tractusx/traceability-foss/blob/main/tx-backend/INSTALL.md) | ||
| * see [Installation guide](tx-backend/INSTALL.md) | ||
|
|
||
| ### Backend Testing Strategy | ||
| See [TESTING](tx-backend/TESTING.md). | ||
|
|
||
| ## API documentation | ||
| ## API Documentation | ||
| The project follows [OpenAPI Specification](https://swagger.io/specification/) in order to document implemented REST Endpoints. The documentation can be found under [/openapi directory](https://github.com/eclipse-tractusx/traceability-foss/blob/main/tx-backend/openapi/traceability-foss-backend.json) | ||
| or can be viewed in the Swagger UI accessing the url: `{projectBasePath}/api/swagger-ui/index.html` | ||
|
|
||
| ## Licenses | ||
|
|
||
| * [Apache License 2.0](https://github.com/eclipse-tractusx/traceability-foss/blob/main/LICENSE) | ||
| * [CC BY 4.0 License](https://github.com/eclipse-tractusx/traceability-foss/blob/main/LICENSE_non-code) | ||
| * [Apache License 2.0](LICENSE) | ||
| * [CC BY 4.0 License](LICENSE_non-code) | ||
|
|
||
| ## Notice for Docker image | ||
| ## Notice for Docker Image | ||
|
|
||
| Below you can find the information regarding Docker Notice for this application. | ||
|
|
||
| - [Traceability Backend Docker Notice](https://github.com/eclipse-tractusx/traceability-foss/blob/main/DOCKER_NOTICE.md) | ||
| - [Traceability Frontend Docker Notice](https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/DOCKER_NOTICE.md) | ||
| - [Traceability Backend Docker Notice](DOCKER_NOTICE.md) | ||
| - [Traceability Frontend Docker Notice](DOCKER_NOTICE.md) | ||
|
|
||
| ## Contact | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file removed
BIN
-135 KB
...-aspect-models-connected-to-twin-generic/DetailView_With_Code_Viewer_Active.png
Binary file not shown.
48 changes: 48 additions & 0 deletions
48
...-aspect-models-connected-to-twin-generic/DetailView_With_Code_Viewer_Active.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-30.4 KB
...isplay-aspect-models-connected-to-twin-generic/Detail_View_Json_Code_Viewer.png
Binary file not shown.
48 changes: 48 additions & 0 deletions
48
...isplay-aspect-models-connected-to-twin-generic/Detail_View_Json_Code_Viewer.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-67.9 KB
...splay-aspect-models-connected-to-twin-generic/Detail_View_Json_Graph_Viewer.png
Binary file not shown.
48 changes: 48 additions & 0 deletions
48
...splay-aspect-models-connected-to-twin-generic/Detail_View_Json_Graph_Viewer.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-40.9 KB
...isplay-aspect-models-connected-to-twin-generic/Detail_View_Json_Tree_Viewer.png
Binary file not shown.
48 changes: 48 additions & 0 deletions
48
...isplay-aspect-models-connected-to-twin-generic/Detail_View_Json_Tree_Viewer.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-16.6 KB
docs/concept/#435-display-aspect-models-connected-to-twin-generic/Error_View.png
Binary file not shown.
48 changes: 48 additions & 0 deletions
48
docs/concept/#435-display-aspect-models-connected-to-twin-generic/Error_View.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-114 KB
...435-display-aspect-models-connected-to-twin-generic/Viewer_Full_screen_mode.png
Binary file not shown.
48 changes: 48 additions & 0 deletions
48
...435-display-aspect-models-connected-to-twin-generic/Viewer_Full_screen_mode.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.