Polyglot Microfrontends styleguide

A styleguide microfrontend.

What is this?

This is an example microfrontend repo demonstrating how to use single-spa. You can see the code running at https://polyglot.microfrontends.app.

How does it work?

Full article

This repository is a javascript project that creates a javascript bundle that is an in-browser javascript module (explanation on youtube / bilibili). The currently deployed version of the in-browser module can be seen at https://polyglot.microfrontends.app/importmap.json.

This project uses webpack and babel. It was generated from create-single-spa.

Whenever a pull request is merged to master, CircleCI builds and deploys the project. The "workflows" view (pictured below) can be seen if you are logged into CircleCI. Deployments for this in-browser module are completely independent of deployments for any other module.

Local development

Full documentation

Tutorial video: youtube / bilibili

There are two ways to do local development. It is preferred to do one module at a time, whenever possible.

One module at a time

cd styleguide
yarn install
yarn start --https

Note that the port defaults to 8080, but may change if 8080 is unavailable. Go to https://localhost:8080/polyglot-mf-styleguide.js and verify that you are able to load the file without any SSL problems. To solve SSL problems, see these instructions.

Now, go to https://polyglot.microfrontends.app. In the browser console, run the following:

localStorage.setItem('devtools', true);

Refresh the page. Click on the tan / beige rectangle:

Set an import map override to 8080.

Refresh the page. Your local code for this module will now be running on https://polyglot.microfrontends.app. You may make changes locally and refresh the page to see them.

All modules together

Run the root-config project locally:

cd root-config
yarn install
yarn start

Now follow the steps above for "One module at a time" for each of the modules you wish to work on.

Adapting for your organization

Feel free to fork and modify any files you would like when doing a proof of concept for your organization. When it's time to actually create / adapt your organization's projects, consider using create-single-spa instead of forking this repository.