From 4bce756646d50227fb7e5b5889c58eb88c0c1644 Mon Sep 17 00:00:00 2001 From: juarez Date: Thu, 10 Aug 2023 18:18:50 +0200 Subject: [PATCH] Add teiler-ui module documentation --- ccp/modules/teiler-ui.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 ccp/modules/teiler-ui.md diff --git a/ccp/modules/teiler-ui.md b/ccp/modules/teiler-ui.md new file mode 100644 index 0000000..28817fb --- /dev/null +++ b/ccp/modules/teiler-ui.md @@ -0,0 +1,17 @@ +# Teiler +This module orchestrates the different microfrontends of the bridgehead as a single page application. + +## Teiler Root Config +Single SPA component that consists on the root HTML site of the single page application and a javascript code that +gets the information about the microfrontend calling the teiler core and is responsible for registering them. With the +resulting mapping, it can initialize, mount and unmount the required microfrontends on the fly. + +The microfrontends run independently in different containers and can be based on different frameworks (Angular, Vue, React,...) +This microfrontends can run as single alone but need an extension with Single-SPA (https://single-spa.js.org/docs/ecosystem). +There are also available three templates (Angular, Vue, React) to be directly extended to be used directly in the teiler. + +## Teiler UI +It consists on the main dashboard and a set of embedded services. + +## Teiler Core +In this component, the microfrontends are configured.