This document contains the following sections:
Luigi is an open source JavaScript framework for micro frontends. Micro frontends can be used to divide big frontend monoliths into smaller, simpler, independent chunks.
TIP: Go to our FAQ section to find more detailed answers to questions like What are micro frontends?
The Luigi framework provides configuration options, API functions, and out-of-the-box features which make migrating to a micro frontend architecture easier.
Furthermore, Luigi is technology-agnostic, which means you can use toolkits like OpenUI5, Angular, React, Vue, or anything else to create your frontend.
Luigi consists of two main parts:
Luigi Core - refers to the "main app", in which your micro frontends (a.k.a. views) will be embedded. It offers some of the following configurable features:
- Navigation - consistent user navigation created using specific Luigi parameters.
- Authorization - integration with an authentication provider, allowing users to log in.
- Localization - displaying an application in multiple languages.
- General settings - other settings that can be configured in Luigi, such as HTML attributes, third-party cookie configuration and more.
- API - functions to help with almost every part of your app: navigation, authorization, adding a search box, configuring a light/dark theme and others.
Luigi Client - refers to Luigi options related to micro frontends:
- API - diverse API functions which can be used on the micro frontend side.
- Communication - sending messages between the micro frontend and the main application (Luigi Core module).
If you want to begin developing your own app with Luigi, start here:
Follow these steps to create a global user interface and host a full web application in Luigi:
- Set up a Luigi Core application on one of the following frameworks:
- Configure the application according to your needs. For example, you can begin by configuring the basic navigation of your application.
Follow these steps to add Luigi Client features to your existing micro frontends:
- Install Luigi Client.
- Use the functions and parameters provided by the Luigi Client API. You can find them in the Luigi Client API documentation.
Here you can find some Luigi example applications and scenarios, starting from simple to more complex:
This is a very simple example of a Luigi application inside a single HTML file. It is not intended for any real-life use.
You can run it by copying and pasting this code in a text editor, then saving it as an HTML file:
<!DOCTYPE html>
<html lang="en">
<head>
<title>Hello Luigi</title>
<link rel='stylesheet' href='https://unpkg.com/@luigi-project/core/luigi.css'>
<meta charset="utf-8">
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<script src="https://unpkg.com/@luigi-project/core/luigi.js"></script>
<script>
Luigi.setConfig({
navigation: {
nodes: [{
pathSegment: 'home',
hideFromNav: true,
children: [{
pathSegment: 'hello',
label: 'Hello Luigi',
viewUrl: 'https://fiddle.luigi-project.io/examples/microfrontends/multipurpose.html',
isolateView: true,
context: {
title: 'Hello Luigi!',
content: " ",
imgUrl: "https://fiddle.luigi-project.io/img/logos/Luigi-logo_rgb.svg",
imgWidth: "300",
imgTopMargin: true
}
},{
pathSegment: 'hello2',
label: 'Hello Maryna',
viewUrl: 'https://fiddle.luigi-project.io/examples/microfrontends/multipurpose.html',
isolateView: true,
context: {
title: 'Hello Maryna!',
content: " ",
imgUrl: "https://fiddle.luigi-project.io/img/logos/Luigi-logo_rgb.svg",
imgWidth: "300",
imgTopMargin: true
}
}]
}]
},
routing: {
useHashRouting: true
},
settings: {
responsiveNavigation: 'semiCollapsible',
header: {
title: 'Hello Luigi',
logo: 'https://fiddle.luigi-project.io/img/luigi.png'
}
}
});
</script>
</body>
</html>The Luigi Fiddle website is a sandbox playground where you can test Luigi. Simply click on Modify Config at the bottom right of the page to make changes to the Luigi application.
In the Examples section of our documentation, you can find links to several "Hello World" example applications which can help you explore Luigi's functions:
You can install them by following the instructions in the README file of each example.
Our tutorial on how to create a React and UI5 web-shopping application is intended for beginners, but it still delves deeper into Luigi's functions. It covers topics such as:
- how to create a Luigi app from scratch
- how to use the Luigi Core and Client APIs
- how to create a micro frontend
- how to add localization to your app and display it in multiple languages
The whole tutorial should take about an hour to complete. The source code for the tutorial app can be found here.
This example application was created for testing purposes and it includes all possible Luigi features in one place. It is useful if you want to explore our framework in more detail or contribute to the Luigi project.
You can find the e2e test application and instructions on how to install it here.
In the expert scenarios section of the documentation, you can find implementations of more complex Luigi use cases, such as using feature toggles or authenticating with Google Cloud Identity.
-
GitHub Discussions - ask (or answer) questions related to Luigi, search for previously answered questions, and rate the answers for helpfulness.
-
Slack Channel - get Luigi updates, contact the Luigi team on Slack, and explore previous discussions.
-
GitHub contribution - if you have a specific improvement idea or want to contribute to Luigi, you can create an issue and pull request. Please follow our contribution guidelines when doing so.