A workshop geared to help you create your first microfrontend using react and module federation. This course will give you the basics of the technology that makes it possible and how it all works together. All of the code will be operating in a monorepo for convenience and ease of adoption.
This course should take 1-3 hours depending on your proficiency.
- Intermediate hands on experience in React.
- Basic knowledge of Http Methods and javascript loading.
Microfrontend architecture is an approach to breaking up your front-end into a set of independently deployable, loosely coupled applications and/or components. These applications are then assembled together to act as a single user experience, once deployed. We do this using a new technology called Module Federation. We have a single Host application which wraps up our single page applications represented as remotes.
Module Federation aims to solve the sharing of modules in a distributed system, by shipping those critical shared pieces as macro or as micro as you would like. It does this by pulling them out of the the build pipeline and out of your apps.
More information here: Module Federation
There are two main concepts to get your head around; the Host and the Remote's.
When we talk about micro-frontends, we often use words like HOST and REMOTE. A host is a parent application that ties all remotes together. A remote can be many things, but in the context of what we will be learning, a remote is essentially a single page react application.
Often time a host can extend configuration, security, types, routing, and many other features to remotes, so that each remote does not have to implement them individually.
- Eager: Load all remotes up front inside the host's webpack.config.js. Must have knowledge of all remotes at startup.
- Dynamic: Load a single remote using React.Lazy on demand only when requested. Must have knowledge of only the requested remote when you view that page or component.
- Delegated: Prefetch all remotes on load, but only load them when requested. Must have knowledge of all remotes on load, but they do not need to be available on load.
In this workshop we are going to build a simple application which allows you to view a list of movies and then look at additional details about a select movie. The application will use React, javascript, bootstrap css, module federation, and webpack.
For now we will keep the structure loose and simple to understand:
.
├── 📁 host
│ ├── 📁 public
│ ├── 📁 src
│ │ ├── 📁 components
│ │ ├── 📁 pages
│ │ ├── 📄 routing.jsx
│ │ └── 📄 index.jsx
│ ├── 📄 webpack.config.js
│ └── 📄 package.json
├── 📁 remotes
│ ├── 📁 home
│ │ ├── 📁 public
│ │ ├── 📁 src
│ │ │ ├── 📄 app.jsx
│ │ │ ├── 📄 bootstrap.js
│ │ │ └── 📄 index.js
│ │ ├── 📄 webpack.config.js
│ │ └── 📄 package.json
│ ├── 📁 list-movies
│ │ └── . . .
│ └── 📁 view-movie
│ └── . . .
├── 📄 package.json
└── 📄 pnpm-workspace.yaml
- First off we want to branch or fork this repository.
https://github.com/cfryerdev/workshope-mfe-react
- Secondly we want to create a default package to manage the solution using pnpm and setup pnpm to manage our workspaces. Open a terminal in this directory and execute
npm install -g pnpm
pnpm init
- Next we want to create a few directories that represents our solution structure.
mkdir host
mkdir remotes
mkdir remotes/home
mkdir remotes/list-movies
mkdir remotes/view-movie
- Now lets setup our host: First we want to copy down the minimal react mfe template from:
cd host
git clone https://github.com/cfryerdev/mfe-reactjs-template .
Put this in the host folder and take a moment to explore the directory and see whats inside.
-
Lets configure the project we just copied and make sure it will function as a container for our remotes.
- First we want to go into
webpack.config.jsand look at the three main variables at the top, by default this is setup for host. - Since this is the host, we dont really have to do much else here.
- First we want to go into
-
Lets copy down the minimal react mfe template again into each of the remote folders. Lets start with the Home remote...
cd ..
cd remotes
cd home
git clone https://github.com/cfryerdev/mfe-reactjs-template .
Put this in the remotes/home folder.
-
Lets configure the project we just copied and make sure it will function as a a remote.
- First we want to go into
webpack.config.jsand look at the three main variables at the top, by default this is setup for host, so we need to name thisremote_homeby using the_packageNamevariable. - We need to update the
_portvariable to3001. We increment this for each remote.
- First we want to go into
-
Lets copy down the minimal react mfe template again into each of the remote folders. Lets setup the List Movies remote...
cd ..
cd list-movies
git clone https://github.com/cfryerdev/mfe-reactjs-template .
Put this in the remotes/list-movies folder.
-
Lets configure the project we just copied and make sure it will function as a a remote.
- First we want to go into
webpack.config.jsand look at the three main variables at the top, by default this is setup for host, so we need to name thisremote_listmoviesby using the_packageNamevariable. - We need to update the
_portvariable to3002. We increment this for each remote.
- First we want to go into
-
Lets copy down the minimal react mfe template again into each of the remote folders. Lets setup the View Movie remote...
cd ..
cd view-movie
git clone https://github.com/cfryerdev/mfe-reactjs-template .
Put this in the remotes/view-movie folder.
-
Lets configure the project we just copied and make sure it will function as a a remote.
- First we want to go into
webpack.config.jsand look at the three main variables at the top, by default this is setup for host, so we need to name thisremote_viewmovieby using the_packageNamevariable. - We need to update the
_portvariable to3003. We increment this for each remote.
- First we want to go into
-
Lets create our pnpm workspace so its easier to run and build our solution. In the root of the directory, create a file called
pnpm-workspace.yamland put the following inside:
packages:
- host
- remotes/home
- remotes/list-movies
- remotes/view-movie
- Lets update package.json in our root directory, this will have the scripts we need for local development and building...
{
"name": "workshope-mfe-react",
"version": "1.0.0",
"scripts": {
"install": "",
"start": "concurrently \"npm run start:home\" \"npm run start:list-movies\" \"npm run start:view-movie\" \"npm run start:host\"",
"install:host": "cd host && npm install",
"start:host": "cd host && npm start",
"build:host": "cd host && npm run build",
"install:home": "cd remotes && cd home && npm install",
"start:home": "cd remotes && cd home && npm start",
"build:home": "cd remotes && cd home && npm run build",
"install:list-movies": "cd remotes && cd list-movies && npm install",
"start:list-movies": "cd remotes && cd list-movies && npm start",
"build:list-movies": "cd remotes && cd list-movies && npm run build",
"install:view-movie": "cd remotes && cd view-movie && npm install",
"start:view-movie": "cd remotes && cd view-movie && npm start",
"build:view-movie": "cd remotes && cd view-movie && npm run build"
},
"dependencies": {
"concurrently": "^7.0.0"
}
}
- We should now be able to run the project and make sure each stand up correctly, make sure you do this from the root directory:
pnpm i
pnpm start
You should be able to look through the console and see all three are available. If the apps dont open for you, Click the following urls and make sure they display "React Minimal MFE Template":
- http://localhosthttp:3000/
- http://localhosthttp:3001/
- http://localhosthttp:3002/
- http://localhosthttp:3003/
If these are not all returning correctly, re-assess the steps above or look at the troubleshooting section.
- We should be ready to start building our UI and see how it all ties together!
Before we begin, lets make this a little easier on ourselves and ensure that only the host opens in a browser when we load the application stack. We do this by going into each webpack.config.js file in each remote (but not the host) and set the open property to false on line 20.
Next, we are going to just use a simple drop in router; Lets open the host/src/ and add the file routes.jsx and add the followings line:
import React from "react";
import { Routes, Route } from "react-router";
const HomePage = () => {
return (<>Home Page</>)
};
const ListMoviesPage = () => {
return (<>List Movies Page</>)
};
const ViewMoviePage = ({ id }) => {
return (<>View Movie Page: {id}</>)
};
const NotFoundPage = () => {
return (<>Page not found...</>)
};
const Router = () => (
<Routes>
<Route path="/" element={<HomePage />} />
<Route path="/movies" element={<ListMoviesPage />} />
<Route path="/movies/:id" element={<ViewMoviePage />} />
<Route path="*" element={<NotFoundPage />} />
</Routes>
);
export default Router;
Lets now update our host/src/ file app.jsx to use the router we just added:
import React from 'react';
import { BrowserRouter } from "react-router-dom";
import Routing from "./routes";
const App = () => {
return (
<BrowserRouter>
<Routing />
</BrowserRouter>
);
};
export default App;
This gives us a few pages we can explore by going to the paths above. Lets update each remote's app.jsx to return something unique. This will give us some routes that we can use to navigate between remotes.
Next we need to add a quick utility and add a few pages. Lets start by adding our dynamic loading remotes script. Create a file called dynamic-remotes.jsx and put the following within it:
const loadRemote = ({ url, scope }) =>
new Promise((resolve, reject) => {
__webpack_require__.l(url,
event => {
if (event?.type === 'load') {
return resolve();
}
const realSrc = event?.target?.src;
const error = new Error();
error.message = 'Loading script failed.\n(missing: ' + realSrc + ')';
error.name = 'ScriptExternalLoadError';
reject(error);
},
scope
);
});
const initSharing = async () => {
if (!__webpack_share_scopes__?.default) {
await __webpack_init_sharing__('default');
}
};
const initContainer = async (containerScope) => {
try {
if (!containerScope.__initialized && !containerScope.__initializing) {
containerScope.__initializing = true;
await containerScope.init(__webpack_share_scopes__.default);
containerScope.__initialized = true;
delete containerScope.__initializing;
}
} catch (error) {
// If the container throws an error, it is probably because it is not a container.
// In that case, we can just ignore it.
}
};
/*
Dynamically import a remote module using Webpack's loading mechanism:
https://webpack.js.org/concepts/module-federation/
*/
const importRemote = async ({
url,
scope,
module
}) => {
if (!window[scope]) {
// Load the remote and initialize the share scope if it's empty
await Promise.all([
loadRemote({ url, scope }),
initSharing(),
]);
if (!window[scope]) {
const error = new Error(
`Remote loaded successfully but ${scope} could not be found! Verify that the name is correct in the Webpack configuration!`
);
console.log({ error });
throw error;
}
// Initialize the container to get shared modules and get the module factory:
const [, moduleFactory] = await Promise.all([
initContainer(window[scope]),
window[scope].get(module.startsWith('./') ? module : `./${module}`),
]);
return moduleFactory();
} else {
const moduleFactory = await window[scope].get(
module.startsWith('./') ? module : `./${module}`
);
return moduleFactory();
}
};
export default importRemote;
Now we can update our routes to return each remote instead of a page. Open routes.jsx again and lets make the following updates:
import React from "react";
import { Routes, Route } from "react-router";
import { useParams } from "react-router-dom";
import importRemote from "./dynamic-remotes";
// Home Page
const HomePage = React.lazy(() =>
importRemote({
url: "http://localhost:3001/remote.js",
scope: "remote_home",
module: "Application",
})
);
// List Movie Page
const ListMoviesPage = React.lazy(() =>
importRemote({
url: "http://localhost:3002/remote.js",
scope: "remote_listmovies",
module: "Application",
})
);
// View Movie Page
const ViewMovieRemote = React.lazy(() =>
importRemote({
url: "http://localhost:3003/remote.js",
scope: "remote_viewmovie",
module: "Application",
})
);
const ViewMoviePage = () => {
let { id } = useParams();
return (<ViewMovieRemote id={id} />);
};
const NotFoundPage = () => {
return <>Page not found...</>;
};
const Router = () => (
<Routes>
<Route path="/" element={<HomePage />} />
<Route path="/movies" element={<ListMoviesPage />} />
<Route path="/movies/:id" element={<ViewMoviePage />} />
<Route path="*" element={<NotFoundPage />} />
</Routes>
);
export default Router;
Its time to run the project! Open a terminal in the root of the solution and type:
pnpm i
pnpm start
It should all spin up in parallel and you can visit: http://localhosthttp:3000/
You can check out each remote from within the host by using:
Now lets sit and talk about what we just built and the WHY behind the patterns you saw.
Check out a fully functional example with layouts and navigation:
Here are some common questions I am often asked:
- How often or under what circumstances would I create a new host? When you have a completely unique layout, unique userbase, or different authentication method; you should consider having multiple hosts.
- Can I use other frameworks instead of React? Absolutely, You can use this framework in React, Vue, Angular and even MVC. You can even use packaged frameworks for your host just as NextJS or Remix.