Product Traceability FOSS Backend

DEPRECATED

This is no longer supported, please consider using https://github.com/catenax-ng/tx-traceability-foss instead.

What is TRACE-FOSS?

Trace-FOSS 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. TRACE-FOSS product composes of the backend and frontend repositories, frontend repository can be found under GitHub repository.

Getting started

Prerequisites

• JDK 17
• Docker Engine

Installation

• see Installation guide

Releasing

• see Releasing guide

Running tests

Unit tests

To run unit tests invoke following command:

mvn clean test

Integration tests

Product Traceability FOSS Backend relies on Testcontainers library in order to provide persistence layer, thus Docker Engine is required to be running.

To run integration tests invoke following command:

mvn clean verify -PiT

Running all tests

To run all tests invoke following command:

mvn -DskipTests=false clean verify -PiT

Please note that this task depends on integrationTest task, so it's required to have Docker Engine running.

API documentation

The project follows OpenAPI Specification in order to document implemented REST Endpoints. The documentation can be found under /openapi directory or can be viewed in the Swagger UI accessing the url: {projectBasePath}/api/swagger-ui/index.html

Coding styles

To maintain coding styles we utilize EditorConfig tool, see configuration file for the details.

IDE plugins

• IntelliJ IDEA ships with built-in support for .editorconfig files
• Eclipse plugin
• Visual studio code plugin

Licenses

Apache 2.0 (https://www.apache.org/licenses/LICENSE-2.0) - see LICENSE