README.md

Authority Portal

Frontend (UI) of Authority Portal
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Compatibility
3. Getting Started
4. Configuration
5. Running dev mode
6. Build docker image
7. Contributing
8. License
9. Contact

About This Component

Frontend for sovity's Dataspace Authority Portal, written in Angular with TypeScript, NGXS State Management and TailwindCSS Framework.

(back to top)

Configuration

Both the docker image and the locally run build can be configured via ENV Variables:

# Required: Backend URL
AUTHORITY_PORTAL_FRONTEND_BACKEND_URL=https://my-portal.sovity.io

All available configuration options can be found in app-config.ts

(back to top)

Development

Local Development

For local development Node16 and NPM are required.

Local Development uses a type-safe Fake Backend.

This requires the API definitions for new and changed endpoints to be ready, as the data will be filled in by the UI Fake Backend.

To start the frontend with the fake backend, please either run:

# Expects the API Client Library to be built
npm run start

or

# Always re-builds the API Client Library
npm run cold-start

(back to top)

Local E2E Development

Requires Node16 and NPM and a running backend in local development mode (Port 8080).

This can use this to manually test backend implementations in interaction with the UI.

To run the frontend against a locally running backend, please either run:

# Expects the API Client Library to be built
npm run start-e2e-dev

or

# Always re-builds the API Client Library
npm run cold-start-e2e-dev

(back to top)

License

See LICENSE for more information.

(back to top)

Contact

contact@sovity.de

(back to top)