Qiankun

Blazing fast, simple and complete solution for micro frontends.

Micro frontend
umijs/qiankunqiankun.umijs.orgqiankun

README

qiankun

npm version coverage npm downloads build status dumi


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🧐.

:sparkles: 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


  1. ``` sh
  2. $ yarn add qiankun  # or npm i qiankun -S
  3. ```

📖 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:

- Tutorial
- API Reference
- FAQ
- Community

💿 Examples


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

  1. ``` sh
  2. $ git clone https://github.com/umijs/qiankun.git
  3. $ cd qiankun
  4. ```

Now install and run the example:

  1. ``` sh
  2. $ yarn install
  3. $ yarn examples:install
  4. $ yarn examples:start
  5. ```

Visit http://localhost:7099.

undefined

🎯 Roadmap


See Qiankun 3.0 Roadmap

👥 Contributors


Thanks to all the contributors!

contributors

🎁 Acknowledgements


- single-spa What an awesome meta-framework for micro-frontends!
- import-html-entry An assets loader that supports html entry.

📄 License


Qiankun is MIT licensed.