Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/donadam2/micro-frontend-second-inner-app
Example of creating app which is a remote entry of an app using webpack module federation
https://github.com/donadam2/micro-frontend-second-inner-app
react webpack-module-federation webpack5
Last synced: 17 days ago
JSON representation
Example of creating app which is a remote entry of an app using webpack module federation
- Host: GitHub
- URL: https://github.com/donadam2/micro-frontend-second-inner-app
- Owner: DonAdam2
- License: mit
- Created: 2021-12-16T17:58:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T13:46:36.000Z (6 months ago)
- Last Synced: 2024-07-10T16:19:45.793Z (6 months ago)
- Topics: react, webpack-module-federation, webpack5
- Language: JavaScript
- Homepage:
- Size: 4.48 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Table of Contents:
- [Overview](#micro-frontend-second-inner-app)
- [Prerequisites](#prerequisites)
- [Installing & getting started](#installing--getting-started)
- [How to create injectable module and expose it to parent sites](#how-to-create-injectable-module-and-expose-it-to-parent-sites)
- [Available scripts](#available-scripts)
## Micro frontend second inner app
- Uses ***module federation plugin*** from webpack to create injectable ***module***.
- This app is the remote entry of [Micro frontend inner app](https://github.com/DonAdam2/micro-frontend-inner-app)
**_Note:_** This app uses live reloading for local development.
## Prerequisites
- nodeJS > 14.X.X or Docker
## Installing / Getting Started
### Development (locally):
- Clone repo => `git clone [email protected]:react-custom-projects/webpack-react-boilerplate.git`
- Navigate to project directory `cd webpack-react-boilerplate`
- Install dependencies => `yarn install`
- Start the development server => `yarn start`
### Development (using Docker):
- Clone repo => `git clone [email protected]:react-custom-projects/webpack-react-boilerplate.git`
- Navigate to project directory `cd webpack-react-boilerplate`
- Install dependencies (required for prettier) => `yarn install`
- Start the development server => `docker-compose up web-dev`
## Docker for production (_basic setup_) (modify it to your needs):
- Update the **_production_** section of the **_Dockerfile_** to meet your needs
- Run the following command to build your image => `docker-compose up web-prod`
## How to create injectable _module_ and expose it to parent sites
- Open **webpack.common.js** file.
1- Import ***ModuleFederationPlugin***:
```
const { ModuleFederationPlugin } = require('webpack').container
```
2- Pass ***ModuleFederationPlugin*** to the ***plugins*** array:
```
plugins: [
new ModuleFederationPlugin({
```
3- Specify the name of the current app (must be unique) in ***ModuleFederationPlugin***:
```
new ModuleFederationPlugin({
name: 'second_inner_app',
```
4- Set the exposed file name in ***ModuleFederationPlugin***:
```
filename: 'remoteEntry.js',
```
5- Define the modules you want to expose from the current app in ***ModuleFederationPlugin***:
```
exposes: {
'./App': path.join(PATHS.src, 'App'),
}
```
**_Note:_** The key you specify for each module you expose in `exposes` object
will be used in the host app to import that module: `/second_inner_app/App`.
6- Add the shared dependencies in ***ModuleFederationPlugin***:
```
new ModuleFederationPlugin({
shared: ['react', 'react-dom'],
}),
```
- Create the component you want to expose.
- Create `bootstrap.js` file and move into it all the code from `index.jsx` file.
- Import `bootstrap.js` **dynamically** inside `index.jsx` file.
```
import('./bootstrap');
```
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.
It will open [http://localhost:3002](http://localhost:3002) automatically in the browser to see your app.
All changes will be injected automatically without reloading the page.
You will see in the console the following:
- All redux store related changes
- Any of the following errors:
1. Linting errors.
2. Code format errors (because of [prettier](https://prettier.io/))
### `yarn build`
Builds the app for production to the `dist` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
### `yarn build:serve`
Serves the app on [http://localhost:8082](http://localhost:8082) from the `dist` folder to check the production version.
**_Note:_** Use this script only if you ran the build script `yarn build`.
### `yarn analyze-bundle`
It allows you to analyze the bundle size.