mdhub
npm i mdhub

mdhub

A javascript library to create micro front-end applications

by MemedDev

3.0.0 (see all)License:{"type":"MIT","url":"https://raw.githubusercontent.com/MemedDev/mdhub/master/LICENSE"}TypeScript:Not Found
npm i mdhub
Readme

MdHub

A javascript library to create micro front-end applications

mdhub

Install

You can get it on npm.

npm install mdhub --save

Why

MdHub was created in 2015, when Memed faced a challenge building the new version of its SPA (Single Page Application):

We need to integrate some "screens" of our new SPA on third-party SPAs, something like modules (Memed CTO, 2015)

Some requirements was listed:

  1. Avoid CSS conflict
  2. Avoid JS libraries conflict
  3. Easy to use
  4. Only load what will be used

Putting the SPA into an iframe solves the problems with CSS/JS conflicts.

To be easy to use, a JS Library can be made to create the iframe and exposes some methods to communicate with it using postMessage.

To only load what will be used, the SPA can have custom compilations (one for each third-party SPA), but will be hard to mantain. Other solution was to split the SPA into modules, and create an iframe for each module - this is what MdHub does and why it was created.

MdHub takes care of:

  • Creating an iframe for each module
  • iframe styling
  • Communication between each module using commands and events (something like CQRS/ES) over postMessage
  • iframe displaying control (show or hide a module)
  • Management of modules dependencies (if module.one depends on module.two, MdHub will load it automatically)

Micro front-end is good?

Yes, but it's not a silver bullet. Some advantages:

  • Isolation (if a module breaks, other modules can continue working)
  • Follows the Single Responsibility Principle
  • Separate deployment
  • Separate development (team autonomy)
  • Easy to use different frameworks/libraries

Some references:

Special Thanks

Thank you for all the contributors of versions 1 and 2: Danilo Santos, Gabriel Couto, Cloves Santos, João Sales, Felipe Sousa, Rômulo Argolo, William Espindola, Carlos Júnior.

License

MIT.

Downloads/wk

30

GitHub Stars

11

LAST COMMIT

3yrs ago

MAINTAINERS

1

CONTRIBUTORS

2

OPEN ISSUES

1

OPEN PRs

4
VersionTagPublished
3.0.0
latest
3yrs ago
No alternatives found
No tutorials found
Add a tutorial