Skip to content
master
Switch branches/tags
Code

qiankun

npm version coverage npm downloads build status

qiankunοΌˆδΉΎε€οΌ‰

In Chinese, qian(乾) means heaven and kun(址) earth. qiankun is the universe.

Qiankun enables you and your teams to build next-generation and enterprise-ready web applications leveraging Micro Frontends. It is inspired by and based on single-spa.

πŸ€” Motivation

A quick recap about the concept of Micro Frontends:

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

Qiankun was birthed internally in our group during the time web app development by distributed teams had turned to complete chaos. We faced every problem micro frontend was conceived to solve, so naturally, it became part of our solution.

The path was never easy, we stepped on every challenge there could possibly be. Just to name a few:

  • In what form do micro-apps publish static resources?
  • How does the framework integrate individual micro-apps?
  • How to ensure that sub-applications are isolated from one another (development independence and deployment independence) and runtime sandboxed?
  • Performance issues? What about public dependencies?
  • The list goes on long ...

After solving these common problems of micro frontends and lots of polishing and testing, we extracted the minimal viable framework of our solution, and named it qiankun, as it can contain and serve anything. Not long after, it became the cornerstone of hundreds of our web applications in production, and we decided to open-source it to save you the suffering.

TLDR: Qiankun is probably the most complete micro-frontend solution you ever met🧐.

✨ Features

Qiankun inherits many benefits from single-spa:

  • πŸ“¦ Micro-apps Independent Deployment
  • πŸ›΄ Lazy Load
  • πŸ“± Technology Agnostic

And on top of these, it offers:

  • πŸ’ƒ Elegant API
  • πŸ’ͺ HTML Entry Access Mode
  • πŸ›‘ Style Isolation
  • 🧳 JS Sandbox
  • ⚑ Prefetch Assets
  • πŸ”Œ Umi Plugin Integration

πŸ“¦ Installation

$ yarn add qiankun  # or npm i qiankun -S

πŸ“– Documentation

You can find the Qiankun documentation on the website

Check out the Getting Started page for a quick overview.

The documentation is divided into several sections:

πŸ’Ώ Examples

Inside the examples folder, there is a sample Shell app and multiple mounted Micro FE apps. To get it running, first clone qiankun:

$ git clone https://github.com/umijs/qiankun.git
$ cd qiankun

Now install and run the example:

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

Visit http://localhost:7099.

🎯 Roadmap

  • Parcel apps integration (multiple micro-apps displayed at the same time, but only one uses router at most)
  • Communication protocol between the framework and hosted micro-apps
  • Customizable side-effect hijacker
  • Nested micro-apps

🎁 Acknowledgements

License

Qiankun is MIT licensed.