End-User API

This project contains a graphical user interface (GUI) for an onboarding demonstrator. It implements a sample onboarding flow for small and medium-sized enterprises (SMEs) in a fictitious dataspace according to the use case description.

1. Use Case Description
2. Onboarding Flow
   1. Catena-X
   2. ...
3. End-User API
   1. Requirements
   2. Wireframes
   3. Implementation Plan

Technology

The End-User API is divided into frontend and backend components. It is an Angular application that uses the EDC Data Dashboard library which is publicly available.

Features

• The user can register to a dataspace. This repository currently covers the onboarding to Catena-X according to the Catena-X registration process.
• The user can share their data with the configured dataspace(s).
• The user can discover and access data in the configured dataspace(s).

Style

This application uses daisyUI, based on Tailwind CSS, as component framework.

Configuration

Connector

This application uses the Think-iT-Labs/edc-connector-client for the integration of the EDC Management API.

Application

The configuration is located at app-config.json.

Deployment

Docker

To run this application in Docker, you have to execute the following commands.

1. docker build -t end-user-api .
2. docker run -p 8080:8080 -v $PWD/public/config/:/app/config -v $PWD/nginx.conf:/etc/nginx/conf.d/default.conf end-user-api

This application is available at http://localhost:8080.

Local

To run this application locally, you have to execute the following commands.

Note that 2. and 3. have to be executed for each run.

1. npm install
2. npm run lib-start
3. npm run start

The dashboard is available at http://localhost:4200.

License

This project is licensed under the Apache License 2.0.