Skip to content

Latest commit

 

History

History

core

Luigi Core

Overview

Luigi Core is a micro frontend framework written in Svelte. To learn how it works, read this document.

Usage

Read the subsections to learn how to use the project.

Link and build dependencies

Linking and building is the preferred development method. This monorepo uses custom linking and building scripts for project management.

Follow these steps:

  1. Install dependencies and link cross-dependencies. The npm run bootstrap should be executed on root level. It executes the Node Package Manager (NPM) installation and links cross-dependencies from the symbolic-links.json file. It is enough to run it once before development or if updating package versions.

    npm run bootstrap
  2. Bundle the Luigi Core. To bundle Core run npm run bundle. To run bundle in every package simply run the same command but on root level

    npm run bundle
  3. When developing Luigi Core only, you may use the watch option for better development experience

    npm run bundle-develop

You can see the Luigi Core in action by running the Angular example application.

Build and watch with a simple development environment

Use the following steps, if you want to have a simpler development environment with less output and not the full-blown e2e application. This becomes handy if you want to debug a certain scenario where you already have a Luigi configuration snippet.

  1. Install dependencies.
    npm install
  2. Run webserver with live reload.
    npm run simpledev

This will create (or use, if already existing) a simple Luigi app under /dev-tools/simple-app where you can make changes according to your needs.

Run tests

To perform the unit test on JavaScript files, run npm test.