PortalCore

Table of Contents

1. About The Project
   • Quality Gate
   • Release Notes
2. Getting Started
3. Usage
4. Development Scripts
   • build:dev
   • deploy-local-dev-package
   • restore-to-registry-package
   • Typical development workflow
5. Security Policy
6. Contributing
7. License
8. Contact

About The Project

This project was generated with Angular CLI version 18.1.1. It contains central components for DEMIS-Frontends.

Quality Gate

Release Notes

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

Getting Started

Developing the library

The library can be built for development using the following command:

npm run watch

This will build the library and watch for changes. The library can be used in the demo application that ships with this repository. There is no need to link the library to the demo application by hand, as the demo application already knows the paths to the dist folder of the library, thanks to tsconfig.json. Once the library is built, the demo application can be started using the following command:

npm run start

To avoid having to start and manage two terminal windows for the commands above, you can simply run the following command to start the watch and serve processes in one terminal window:

npm run dev

This will start the library in watch mode and the demo application in serve mode. The demo application will automatically reload when changes are made to the library.

For further information on how to use the library in the demo application, please refer to the demo application README.

How to build

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

npm clean-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 run test

Usage

To use this library in your project, install it via npm, if you have access to a registry, where this library is pushed to:

npm install @gematik/demis-portal-core-library

If you do not have access to a registry that has this library available, you first need to build it yourself (see: build:dev). Afterwards, you can deploy this local build to any desired Angular project by utilizing the convenience script deploy-local-dev-package.

BEWARE! This will most likely always affect the dependency tree of the target Angular project!

Creating a new component

To create a new component in the library, you can use the Angular CLI command:

ng g c components/component-name --project @gematik/demis-portal-core-library

Development Scripts

There are several scripts available for local development that simplify the workflow between local TGZ builds and registry installations:

build:dev

Builds the library and packs it into a TGZ file in the dist/ directory. This is useful for local development and testing before deploying to a registry.

Usage:

# Build the library and create a TGZ file in dist/
npm run build:dev

deploy-local-dev-package

Installs the locally built TGZ version of the Portal-Core-Library into a target project.

Usage:

# Installs the latest TGZ file from dist/
npm run deploy-local-dev-package ../portal-shell

# Or directly:
node .local-scripts/deploy-local-dev-package.js ../portal-shell

Features:

• Automatically finds the latest TGZ file in the dist/ directory
• Installs the local version as file: dependency
• Clears caches and reinstalls all dependencies
• Automatically validates target directory and library project

restore-to-registry-package

Restores registry versions of the Portal-Core-Library and checks for available updates.

Usage:

# Automatic update to latest stable version
npm run restore-to-registry-package ../portal-shell

# Installation of a specific version
npm run restore-to-registry-package ../portal-shell 2.0.1

# Or directly:
node .local-scripts/restore-to-registry-package.js ../portal-shell [version]

As can be seen, the script can also be used to install a specific version of the library. Typically, this is not necessary, as the latest version is always installed by default.

Typical Development Workflow

1. Local development: Make changes to Portal-Core
2. Build: Run npm run build
3. Deployment: npm run deploy-local-dev-package ../portal-shell for testing
4. Restoration: npm run restore-to-registry-package ../portal-shell for production

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 2023-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