Skip to content

sovity/edc-ce

Repository files navigation

Contributors Forks Stargazers Issues Apache 2.0 LinkedIn


Logo

sovity Community Edition EDC

Extended EDC Connector by sovity.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Compatibility
  4. Contributing
  5. License
  6. Contact

About The Project

Eclipse Dataspace Components (EDC) is a framework for building dataspaces, exchanging data securely with ensured data sovereignty.

sovity extends the EDC Connector's functionality with extensions to offer enterprise-ready managed services like "Connector-as-a-Service", out-of-the-box fully configured DAPS and integrations to existing other dataspace technologies.

This repository contains our sovity Community Edition EDCs, providing a self-hostable sovity EDC Connector.

Check out our Getting Started Section on how to run a local sovity Community Edition EDC.

(back to top)

Getting Started

The fastest way to get started is our Getting Started Guide.

(back to top)

Compatibility

Our sovity Community Edition EDC is compatible with productive Tractus-X versions. We stay in sync with the Eclipse EDC that Tractus-X is using.

Some parallel versions might be maintained, although done as sparingly as possible.

Each sovity Enterprise Edition EDC release also releases a sovity Community Edition with the same version ensuring same version usage and naming across API Clients, Connector and Connector UI.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would improve this project, feel free to open a feature request. Don't forget to leave the project a ⭐, if you like the effort put into this version!

Our contribution guideline can be found in CONTRIBUTING.md.

(back to top)

Development

Please note that our sovity Community Edition EDC gets automatically released with our sovity Enterprise Edition EDC. Because of this, most of the tooling and development processes are not public, such as our E2E Test suite and most of our JUnit Integration tests are not present here.

Requirements

  • Docker Environment
  • JDK 17
  • GitHub Maven Registry Access
  • Node 20

To access the GitHub Maven Registry you need to provide the following properties, e.g. by providing a ~/.gradle/gradle.properties.

gpr.user={your github username}
gpr.key={your github pat with packages.read}

Local Development: Backend

The backend can be developed fully using tests.

(back to top)

Local Development: Frontend

As soon as the API model is ready the Fake Backend can be adjusted. The fake backend is mostly type-safe by using the generated API model classes and mappers.

To launch the frontend dev server with the Fake Backend, run:

# Bash, Git Bash or WSL

# Install dependencies (only required once)
(cd connector-ui && npm i)

# Run the dev server with Fake Backend (Local Development)
# Also regenerates the API Client Library
(cd connector-ui && npm run cold-start)

This starts the frontend at http://localhost:3000

The configuration can be found in connector-ui/.env.local-dev.

(back to top)

License

Distributed under the LICENSE. Some deliverables such as APIs, API Clients and Utility Libraries remain under the Apache License 2.0. See LICENSE for more information.

(back to top)

Contact

contact@sovity.de

(back to top)