Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.05 KB

README.md

File metadata and controls

49 lines (32 loc) · 2.05 KB
Raw

KoliBri - Micro Frontends Playground

Using KoliBri in micro frontend environments, enabling multiple versions simultaneously.

Motivation

Utilizing KolBri (or similar libraries providing Web Components) in a micro frontend setup poses a challenge due to global registration of web components, causing conflicts in element names. Typically, this prevents registering multiple versions concurrently (e.g., both would register as kol-button). To overcome this, KoliBri offers a tag name transformer configuration, allowing unique element name suffixes for each version (e.g., kol-button-v1, kol-button-v2).

Additionally, framework adapters can be easily configured, facilitating seamless version switching without extensive code modifications.

Repository Structure

This monorepo is an example implementation for a micro frontend architecture, comprised by the following packages:

  • app: Main application orchestrating various micro-frontends.
  • kolibri-v1-provider: Provides a regular build of KoliBri v1.x including the default theme.
  • kolibri-v2-provider: Offers a build of KoliBri v2.x with the default theme, featuring custom tag names suffixed with -v2.
  • module-v1: A small React module ("Micro frontend") dependent on KolBri v1.x.
  • module-v2: A small React module ("Micro frontend") dependent on KolBri v2.x.

Configuration Highlights

Try It Out

pnpm i
pnpm -r build
cd packages/app
pnpm dev

Second scenario

We have three micro frontends with Angular, React and Vue (in the ./frontends folder). Each of them is using a different version of KoliBri. The main application is in the root folder.

You can run the application with the following commands:

npm start

Is everything installed and built correctly? You can run the application faster with the following command:

npx serve