Skip to content

Module Federation Deployment

Understanding deployment helps you work with Module Federation confidently. Here you will learn the core ideas behind deployment, see working code, and pick up best practices used on real teams.

Deployment Overview

At its core, deployment is about doing one thing well inside your Module Federation project. Once you understand the pattern, you can apply it consistently across features and teams.

Good deployment pays off across the whole codebase: fewer surprises, easier testing, and smoother onboarding. The snippet below is a solid starting point.

# each micro frontend deploys independently
catalog:  https://cdn.example.com/catalog/remoteEntry.js
checkout: https://cdn.example.com/checkout/remoteEntry.js

# the host resolves remotes from a runtime manifest
{ "catalog": "https://cdn.example.com/catalog/remoteEntry.js" }

Independent deployment is the core benefit: each remote ships on its own schedule.

Deployment Example

new ModuleFederationPlugin({
  name: 'app',
  filename: 'remoteEntry.js',
  exposes: { './Widget': './src/Widget' },
  remotes: { other: 'other@http://host/remoteEntry.js' },
  shared: { react: { singleton: true } },
});
  • Start from a minimal Deployment example and grow it only as needed.
  • Keep configuration explicit so Deployment behaves the same in every environment.
  • Name things clearly so teammates understand your Deployment at a glance.
  • Add tests around Deployment early to lock in expected behaviour.

Module Federation Cheatsheet

Key Module Federation settings related to deployment.

Option Example Purpose
name name: 'shell' Unique container name
filename filename: 'remoteEntry.js' Remote entry manifest
exposes exposes: { './X': './src/X' } Modules a remote shares
remotes remotes: { app: 'app@url' } Remotes a host consumes
shared shared: { react: { singleton: true } } Deduplicate libraries
lazy load import('remote/Module') Load remotes on demand
Suspense <Suspense fallback={...}> Handle async loading

How Deployment Works in Module Federation

Deployment builds on Module Federation's ability to load code from another independently built and deployed application at runtime. Each app can be a host, a remote, or both.

Independent deployment is the core benefit: each remote ships on its own schedule.

  • Remotes expose modules through a remoteEntry.js manifest.
  • Hosts declare remotes and import exposed modules dynamically.
  • Shared dependencies are deduplicated, ideally as singletons.
  • Each micro frontend builds and deploys on its own schedule.

Practical Guidance for Deployment

In production, deployment needs careful version management and graceful failure handling. Align shared dependency versions and always render a fallback when a remote cannot load.

Concern Recommendation
Shared versions Use singletons with requiredVersion
Runtime errors Wrap remotes in error boundaries and fallbacks
Deployment Resolve remotes from a runtime manifest
Performance Lazy-load remotes and cache remoteEntry.js

Common Mistakes

  • Skipping error handling and edge cases when wiring up deployment.
  • Leaving deployment untested, so regressions slip into production.
  • Over-engineering deployment before you actually need the extra flexibility.
  • Ignoring documentation, which makes deployment hard for the next developer to change.

Key Takeaways

  • Deployment is a core part of working effectively with Module Federation.
  • Start small and keep deployment focused on a single responsibility.
  • Apply consistent patterns so deployment scales across your project.
  • Test and document deployment to keep it maintainable over time.

Pro Tip

Bookmark this deployment pattern and reuse it. Consistency across your Module Federation codebase is worth more than clever one-off solutions.