@nx/react:module-federation-dev-server

Serve a web application.

Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.

Examples

The Module Federation Dev Server will serve a host application and find the remote applications associated with the host and serve them statically also.
See an example set up of it below:

{
  "serve": {
    "executor": "@nx/react:module-federation-dev-server",
    "configurations": {
      "production": {
        "buildTarget": "host:build:production"
      },
      "development": {
        "buildTarget": "host:build:development"
      }
    },
    "defaultConfiguration": "development",
    "options": {
      "port": 4200,
      "publicHost": "http://localhost:4200"
    }
  }
}

Options playground

Try out this interactive editor of the configuration object. Values are validated as you type and hovering over labels will give you more information.

Options

buildTarget

string

Target which builds the application.

devRemotes

Array<oneOf [string, object ]>

List of remote applications to run in development mode (i.e. using serve target).

open

boolean

Default: false

Open the application in the browser.

port

number

Default: 4200

Port to listen on.

skipRemotes

Array<string>

List of remote applications to not automatically serve, either statically or in development mode. This will not remove the remotes from the module-federation.config file, and therefore the application may still try to fetch these remotes. This option is useful if you have other means for serving the remote application(s). NOTE: Remotes that are not in the workspace will be skipped automatically.

allowedHosts

string

This option allows you to whitelist services that are allowed to access the dev server.

baseHref

string

Base url for the application being built.

host

string

Default: localhost

Host to listen on.

hmr

boolean

Default: false

Enable hot module replacement.

liveReload

boolean

Default: true

Whether to reload the page on change, using live-reload.

memoryLimit

number

Memory limit for type checking service process in MB.

maxWorkers

number

Number of workers to use for type checking.

publicHost

string

Public URL where the application will be served.

parallel

number

Max number of parallel processes for building static remotes

pathToManifestFile

string

Path to a Module Federation manifest file (e.g. my/path/to/module-federation.manifest.json) containing the dynamic remote applications relative to the workspace root.

ssl

boolean

Default: false

Serve using HTTPS.

sslKey

string

SSL key to use for serving HTTPS.

sslCert

string

SSL certificate to use for serving HTTPS.

static

boolean

Whether to use a static file server instead of the webpack-dev-server. This should be used for remote applications that are also host applications.

staticRemotesPort

number

The port at which to serve the file-server for the static remotes.

watch

boolean

Default: true

Watches for changes and rebuilds application.

isInitialHost

Internal

boolean

Default: true

Whether the host that is running this executor is the first in the project tree to do so.