chore: update documentation #89
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Android Release APK for all devicesNote: if the download link expires, please re-run the workflow to generate a new build. Generated at 2025-07-14T11:51:38.325Z UTC |
iOS Release APP for simulatorsNote: if the download link expires, please re-run the workflow to generate a new build. Generated at 2025-07-14T11:52:08.473Z UTC |
jbroma
reviewed
Jul 14, 2025
Member
jbroma
left a comment
jbroma
left a comment
There was a problem hiding this comment.
most looks good, lets just split it - remember that the README in core will be published on npm 👍
jbroma
reviewed
Jul 14, 2025
Comment on lines
5
to
12
| ### Installation | ||
|
|
||
| Use your favorite package manager to install these required packages to your React Native project. | ||
|
|
||
| ```shell | ||
| # Using pnpm | ||
| pnpm add @module-federation/metro @module-federation/metro-plugin-rnc-cli | ||
| ``` |
Member
There was a problem hiding this comment.
we need to differentiate between RNEF and RNC CLI and maybe note that Expo is not supported yet
Comment on lines
14
to
61
| ### Configuration | ||
|
|
||
| Wrap Metro configuration with `withModuleFederation` function that enables module federation in your project. | ||
|
|
||
| ```javascript | ||
| const { withModuleFederation } = require('@module-federation/metro'); | ||
| const { getDefaultConfig, mergeConfig } = require('@react-native/metro-config'); | ||
|
|
||
| const config = {}; | ||
|
|
||
| module.exports = withModuleFederation( | ||
| mergeConfig(getDefaultConfig(__dirname), config), | ||
| { | ||
| name: 'YourAppName', | ||
| remotes: { | ||
| // Define remote applications (for host apps) | ||
| // remoteName: 'remoteName@http://localhost:8082/mf-manifest.json', | ||
| }, | ||
| exposes: { | ||
| // Expose modules (for remote apps) | ||
| // './Component': './src/Component.tsx', | ||
| }, | ||
| shared: { | ||
| react: { | ||
| singleton: true, | ||
| eager: true, | ||
| requiredVersion: '19.1.0', | ||
| version: '19.1.0', | ||
| }, | ||
| 'react-native': { | ||
| singleton: true, | ||
| eager: true, | ||
| requiredVersion: '0.80.0', | ||
| version: '0.80.0', | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| // These experimental flags have to be enabled in order to patch older packages | ||
| // Can be omitted if your project is using supported React Native and Metro versions | ||
| flags: { | ||
| unstable_patchHMRClient: true, | ||
| unstable_patchInitializeCore: true, | ||
| unstable_patchRuntimeRequire: true, | ||
| }, | ||
| } | ||
| ); | ||
| ``` |
Member
There was a problem hiding this comment.
lets split this into:
- Adding the plugin in metro (in here add just name + flags) - flags need proper paragraph on their own
- Configuring MF - lets mention that the configuration is the same as https://module-federation.io/configure/index.html but is not fully implemented and might differ from the target one slightly - you should always refer the official documentation for that
- We're missing a section on wrapping the RN entrypoint in HostApp with
withAsyncStartup- and we need to describe what it does
maybe its also worth to differentiate between MiniApp and HostApp - we assume that HostApp is a one without any exposes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add basic documentation to README.