Code Monkey home page Code Monkey logo

craco-mf's Introduction

craco-mf

Module federation support for CRA5 applications without ejecting and losing update support of react-scripts.

Fork of hasanayan/craco-module-federation, which appears to be unmaintained/abandoned.

Prerequisites

  • Webpack 5
  • CRA 5
  • CRACO 7
  • Node 16+

Note

This is a fork of the original craco-module-federation plugin. Use at your own risk. PRs are welcome; support will be limited.

Install

npm install craco-mf --save-dev

Usage

  1. Add the plugin into your craco.config.js

    const cracoModuleFederation = require('craco-mf');
    
    module.exports = {
        plugins: [{
            plugin: cracoModuleFederation,
            options: { useNamedChunkIds:true } // THIS LINE IS OPTIONAL
          },
        ]
    }
  2. create a file named modulefederation.config.js in the project root. You should export ModuleFederationPlugin constructor options as json from this module. For example;

    const deps = require("./package.json").dependencies;
    
    module.exports = {
      name: "app1",
      exposes: {
        "./Button": "./src/Button",
      },
      remotes: {
        app2: "app2@http://localhost:3002/remoteEntry.js",
      },
      filename: "remoteEntry.js",
      shared: {
        ...deps,
        react: {
          singleton: true,
          requiredVersion: deps["react"],
        },
        "react-dom": {
          singleton: true,
          requiredVersion: deps["react-dom"],
        },
      },
    };
  3. Update the scripts section of your package.json as follows:

      ...
      "scripts": {
        "start": "react-scripts start",
        "build": "react-scripts build",
        "craco:build": "craco build",
        "craco:start": "craco start",
        ...

Testing the plugin locally

There are two test apps in this repository inside test folder (app1 and app2). Install their dependencies on them using yarn (yarn install) and hit yarn start on both of them. When you navigate to app1 it should render the exported button from app2 that says hello from app2

License

Licensed under the MIT License, Copyright Šī¸ 2022 Brandon Faulkner. See LICENSE.md for more information.

Original author Hasan Ayan

craco-mf's People

Contributors

bfaulk96 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤ī¸ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.