Portal-Shell

Table of Contents

1. About The Project
   • Quality Gate
   • Release Notes
2. Getting Started
   • Prerequisites
   • Angular CLI
   • How to build
   • Tests
   • Creating Docker Image
   • Usage
     • Configuration
   • Security Policy
   • Contributing
   • License
   • Contact

About The Project

The shell is the main structue that allows for all micro applications of DEMIS Notification-Portal Microfrontends to be rendered. It has the initial Config for SPA-Framework and an import Map mapping all micro application to their relative URL served Paths. It has the main functionality to show static pages (impressum, about Demis) as well as starting the authorisation Flow for the keylock IAM sytem It provides the start page, navigation and login logic.

Quality Gate

Release Notes

See ReleaseNotes for all information regarding the (newest) releases.

Getting Started

Prerequisites

Before you can build and run the application, you need to install the following software products:

• NodeJS >= 20.0.0
• npm
• A browser for Tests
  • Google Chrome
  • Firefox
• An IDE
  • WebStorm
  • IntelliJ
  • Visual Studio Code

Alternatively, you can use the available development environment defined as Dockerfile in the subfolder .dev/.

Additional libraries

Additionally, the gematik library must be built and integrated.

To do this, please clone the following repo: https://github.com/gematik/DEMIS-portal-core. Then, build the downloaded project according to the instructions, switch to this project, and integrate it with the command

npm install <path_to_this_project>/dist/gematik/demis-portal-core-library

Angular CLI

To use the project, you need the Angular CLI tool and it can be installed and configured as follows:

npm add -g @angular/cli

How to build

The Application can be built using the following commands, if they are installed natively:

npm install
npm run build

Alternatively, a Docker-based development environment is available in the repository under the folder .dev. All you need is to build the Docker Image and then run the npm commands:

docker build -t portal-shell -f .dev/Dockerfile .dev/
docker run --rm -it -v .://project  portal-shell
npm install
npm run build

Tests

From the IDE, if you are using JetBrains ones, you can run the tests by downloading the Karma Plugin.

You can run all unit tests once with the following command:

npm test

Tests can be run in headless mode as well. They can even be run in the Docker Development environment. All you need is to run the tests as follows:

ng test --browsers ChromeHeadless

Creating Docker Image

The Docker Image for the target environment can be built using the following command (requires docker):

docker build -t portal-shell:latest .

Alternativey, a convenient npm target is also available:

npm run docker

Usage

Configuration

The Application runs behind a Nginx Server, which requires some environment variables to be correctly started. The following environment variables are required:

• PORTAL_CSP_HOSTNAME, the list of hostnames, separated by a white space, that should be used with the Content Security Policy

Local usage

It can be started using the command

npm run start

and is then accessible on port 4200. In the background, a proxy setting in the file proxy.conf.json distributes requests to other potentially locally running microfrontends. This allows the entire DEMIS frontend to be developed locally. A running local cluster is necessary for full functionality.

Security Policy

If you want to see the security policy, please check our SECURITY.md.

Contributing

If you want to contribute, please check our CONTRIBUTING.md.

License

Copyright 2024-2025 gematik GmbH

EUROPEAN UNION PUBLIC LICENCE v. 1.2

EUPL © the European Union 2007, 2016

See the LICENSE for the specific language governing permissions and limitations under the License

Additional Notes and Disclaimer from gematik GmbH

1. Copyright notice: Each published work result is accompanied by an explicit statement of the license conditions for use. These are regularly typical conditions in connection with open source or free software. Programs described/provided/linked here are free software, unless otherwise stated.
2. Permission notice: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
   1. The copyright notice (Item 1) and the permission notice (Item 2) shall be included in all copies or substantial portions of the Software.
   2. The software is provided "as is" without warranty of any kind, either express or implied, including, but not limited to, the warranties of fitness for a particular purpose, merchantability, and/or non-infringement. The authors or copyright holders shall not be liable in any manner whatsoever for any damages or other claims arising from, out of or in connection with the software or the use or other dealings with the software, whether in an action of contract, tort, or otherwise.
   3. We take open source license compliance very seriously. We are always striving to achieve compliance at all times and to improve our processes. If you find any issues or have any suggestions or comments, or if you see any other ways in which we can improve, please reach out to: ospo@gematik.de
3. Please note: Parts of this code may have been generated using AI-supported technology. Please take this into account, especially when troubleshooting, for security analyses and possible adjustments.

Contact

E-Mail to DEMIS Entwicklung