chore: update README and add MODULE_FEDERATION/md #3
Conversation
This file contains 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
jbinda
commented
Sep 21, 2022
| Module federation is one of the approaches to create Micro-Frondends architecture for your application. There are the host app that runs firstly on the device and MFEs apps that are used by the host app. That means each container (MFE) that is used by host application could be deployed and maintained independently, so no need to re-deploy host app if any of the containers were changed and re-deployed. This is the key feature of Module Federation. Each team could independently work on any of the packages and deploy it anytime, so the host app will see the changes immediately. | ||
|
|
||
| ## Application Structure | ||
| // TODO |
There was a problem hiding this comment.
still has to be update
There was a problem hiding this comment.
let's not leave todos and create a ticket instead
There was a problem hiding this comment.
@andrewworld are you able to finalise soon? If not I will do as @thymikee wrote
thymikee
reviewed
Sep 21, 2022
Comment on lines
+6
to
+9
| - __ESBuild__: The application that uses __ESBuild Minify Plugin__ and `esbuild-loader` under the hood | ||
| - __Local Chuncks__: The application that uses Repack local chuncks feature | ||
| - [__Module Federation__](./module-federation/MODULE_FEDERATION.md): Huge yarn workspaces that consist of 3 application and 1 module, that could run as standalone applications or running host app with other applications modules usage inside it with __Webpack Module Federation__ feature configured | ||
| - __SWC__: The application using `swc-loader` inside webpack configuration |
There was a problem hiding this comment.
can we make those links to specific folders?
thymikee
reviewed
Sep 21, 2022
| 2. Run `yarn workspace <name> run bootstrap` command for every workspace to install yarn dependencies and pods | ||
|
|
||
| ## Running | ||
| 1. Run `yarn workspace <name> run start` commmand for any workspace you want to run dev server |
There was a problem hiding this comment.
would be cool to list available workspaces :) otherwise you need to check package.json :P
thymikee
reviewed
Sep 21, 2022
|
|
||
| Module Federation functionality was introduced in Webpack 5. It helps to share the code between loosely coupled applications, sharing the same build system optimized for caching. It helps distributed teams to ship large applications faster. Re.Pack 3 ships with Module Federation support out-of-the-box. | ||
|
|
||
| Module federation is one of the approaches to create Micro-Frondends architecture for your application. There are the host app that runs firstly on the device and MFEs apps that are used by the host app. That means each container (MFE) that is used by host application could be deployed and maintained independently, so no need to re-deploy host app if any of the containers were changed and re-deployed. This is the key feature of Module Federation. Each team could independently work on any of the packages and deploy it anytime, so the host app will see the changes immediately. |
There was a problem hiding this comment.
MFE is Micro-Frontend? might using "create Micro-Frondends (MFEs) architecture"
thymikee
reviewed
Sep 21, 2022
| // TODO | ||
|
|
||
| ## Basic Setup | ||
| 1. Go to `module-federation` folder `cd module-federation` |
There was a problem hiding this comment.
you're already in module-federation folder
thymikee
reviewed
Sep 21, 2022
| 3. Run `yarn run:host:android` | ||
|
|
||
| ## Standalone Run | ||
| As was mentions before we could run any of containers as a standaline application (`app1` / `app2` / `module1`). |
There was a problem hiding this comment.
Suggested change
| As was mentions before we could run any of containers as a standaline application (`app1` / `app2` / `module1`). | |
| You can run any of containers as a standalone application (`app1` / `app2` / `module1`): |
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.
Summary
Add more verbose README related with examples
P.S. originator of the content was @andrewworld - however he faced some issue with access so I populated PR with those changes
Test plan