Luigi is a micro front-end JavaScript framework that enables you to create an administrative user interface driven by local and distributed views. Luigi allows a web application to communicate with the micro front-ends which the application contains. To make sure the communication runs smoothly, you can easily configure the settings such as routing, navigation, authorization, and user experience elements.
Luigi consists of Luigi Core and Luigi Client libraries. They interact with each other to leverage communication between the core application and the micro front-end, without compromising the security principles behind the iframe pattern.
Follow the instructions in this document to get started with Luigi. Read this document to install the Luigi Client.
View the application examples to explore Luigi's features.
For details, see Luigi documentation.
All projects in the repository use Prettier to format source code. Run the npm install command in the root folder to install it along with husky, the Git hooks manager. Both tools ensure proper codebase formatting before committing it.
To ensure that existing features still work as expected after your changes, run unit tests using the npm run test command in the core folder.
To ensure that existing features still work as expected after your changes, run UI tests from the Angular example application. Before running the tests, start the sample application by using the npm start command in the application folder.
When the application is ready:
- Run
npm run e2e:openin thecore/examples/luigi-sample-angularfolder to start tests in the interactive mode. - Run
npm run e2e:runin thecore/examples/luigi-sample-angularfolder to start tests in the headless browser.
Use these tests to ensure that applications written for previous versions of Luigi still work after Luigi gets updated with npm. Before running the tests, bundle Luigi by running lerna run bundle in the main repository folder.
Install jq using the brew install jq command. It is required for the script to work, however, you can omit it if the command you are using to run your tests is tagged latest.
- Run
npm run test:compatibilityin the main repository folder to start regression testing. The system will prompt you to select the previous version. - Run
npm run test:compatibility -- --tag latestin the main repository folder to start regression testing with the last version preselected. - On the CI, run
npm run test:compatibility -- --install --tag latestin the main repository folder to install dependencies, bundle Luigi and run the tests with the last version preselected.