qiankun

by umijs

umijs /qiankun

๐Ÿ“ฆ ๐Ÿš€ Blazing fast, simple and completed solution for micro frontends.

7.0K Stars 704 Forks Last release: 6 days ago (v2.0.26) MIT License 476 Commits 92 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

qiankun๏ผˆไนพๅค๏ผ‰

npm version coverage npm downloads Build Status

In Chinese traditional culture

qian
means heaven and
kun
stands for earth, so
qiankun
is the universe.

An implementation of Micro Frontends, based on single-spa, but made it production-ready.

๐Ÿค” Motivation

As we know what micro-frontends aims for:

Techniques, strategies and recipes for building a modern web app with multiple teams using different JavaScript frameworks. โ€” Micro Frontends

Modularity is very important for large application. By breaking down a large system into individual sub-applications, we can achieve good divide-and-conquer between products and when necessary combination, especially for enterprise applications that usually involve multi-team collaboration. But if you're trying to implement such a micro frontends architecture system by yourself, you're likely to run into some tricky problems:

  • In what form do sub applications publish static resources?
  • How does the main application integrate individual sub-applications?
  • How do you ensure that sub-applications are independent of each other (development independent, deployment independent) and runtime isolated?
  • Performance issues? What about public dependencies?
  • And so on...

After solving these common problems of micro frontends, we extracted the kernel of our solution after a lot of internal online application testing and polishing, and then named it

qiankun
.

Probably the most complete micro-frontends solution you ever met๐Ÿง.

๐Ÿ“ฆ Installation

$ yarn add qiankun  # or npm i qiankun -S

๐Ÿ“– Documentation

https://qiankun.umijs.org/

๐Ÿ’ฟ Getting started

This repo contains an

examples
folder with a sample Shell app and multiple mounted Micro FE apps. To run this app, first clone
qiankun
:
$ git clone https://github.com/umijs/qiankun.git
$ cd qiankun

Now run the yarn scripts to install and run the examples project:

$ yarn install
$ yarn examples:install
$ yarn examples:start

Visit

http://localhost:7099
.

:sparkles: Features

  • ๐Ÿ“ฆ Based On single-spa
  • ๐Ÿ“ฑ Technology Agnostic
  • ๐Ÿ’ช HTML Entry Access Mode
  • ๐Ÿ›ก Style Isolation
  • ๐Ÿงณ JS Sandbox
  • โšก Prefetch Assets
  • ๐Ÿ”Œ Umi Plugin Integration

๐ŸŽฏ Roadmap

  • [x] Parcel apps integration (multiple sub apps displayed at the same time, but only one uses router at most)
  • [x] Communication development kits between master and sub apps
  • [ ] Custom side effects hijacker
  • [ ] Nested Microfrontends

โ“ FAQ

https://qiankun.umijs.org/faq/

๐Ÿ‘ฌ Community

https://qiankun.umijs.org/#community

๐ŸŽ Acknowledgements

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.