README

Authority Portal

Manage your Dataspace Report Bug · Request Feature

About The Project

The Authority Portal is an open-source Software as a Service (SaaS) solution designed to streamline the management of your Dataspace. This innovative tool serves as a comprehensive Dataspace Administration Tool, offering a platform where you can seamlessly invite organizations and their users to participate in your Dataspace.

The Authority Portal is not just about managing participants. It also provides multiple avenues to add or acquire connectors and service partners. These partners can offer their own Connector-as-a-Service (CaaS), extending the functionality and versatility of your Dataspace.

As a Dataspace administration tool, the Authority Portal necessitates technical connections with other dataspace components, including the CaaS component. This integration ensures a smooth and efficient operation, enhancing the overall user experience.

(back to top)

Development

To develop new features, once the API definitions are implemented in the backend, the development of both the frontend and backend can start in parallel.

The frontend has a type-safe fake backend which also uses the API models via an autogenerated TypeScript API Client Library.

Once a feature is implemented in both the frontend and backend, it can be manually tested using Local E2E Development.

Local Development

The backend and the frontend can be developed separately:

• Local Backend Development

• Local Frontend Development

(back to top)

Local E2E Development

Local E2E Development is what you use to integration test the backend and frontend locally. Requires JDK17, a Docker Environment and Node 16 / NPM 7.

# Bash, WSL or Git Bash

# Build + Run Backend
(cd authority-portal-backend && ./gradlew clean quarkusDev)

# Build + Run Frontend (basic version with fake Backend*)
(cd authority-portal-frontend && npm i && npm run cold-start-e2e-dev)

For more details on how to launch the frontend, see Frontend Local E2E Development.

(back to top)

Deployment

Productive Deployment Guide

There is a guide on How to deploy the Authority Portal for Production in this repository.

(back to top)

License

See LICENSE for more information.

(back to top)

Contact

If you're interested in deploying the Authority Portal for productive use, we at sovity are ready to assist you. Our team is committed to providing the support you need to make the most of this powerful tool. Contact us today to learn more about how the Authority Portal can transform your dataspace management: [e-mail]

(back to top)