Skip to content

Commit 1f370f4

Browse files
committed
docs(mf-tools): improve readme. add tutorial. add links to all used projects
1 parent 115b180 commit 1f370f4

File tree

3 files changed

+27
-10
lines changed

3 files changed

+27
-10
lines changed

libs/mf-tools/README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,16 @@ This can help to **balance the trade-off** between bundle size and isolation of
1616
1717
## Examples
1818

19-
- [Source Code (Shell, see branch multi-framework-version)](https://red-ocean-0fe4c4610.azurestaticapps.net)
19+
- [Live Example](https://red-ocean-0fe4c4610.azurestaticapps.net)
20+
- [Source Code Shell](https://github.com/manfredsteyer/multi-framework-version)
2021
- [Source Code for Micro Frontend](https://github.com/manfredsteyer/angular-app1)
2122
- [Source Code for Micro Frontend with Routing](https://github.com/manfredsteyer/angular3-app)
23+
- [Source Code for Micro Frontend with Vue](https://github.com/manfredsteyer/vue-js)
24+
- [Source Code for Micro Frontend with AngularJS](https://github.com/manfredsteyer/angularjs-app)
2225

26+
## Tutorial
27+
28+
Please find our [tutorial here](https://github.com/angular-architects/module-federation-plugin/blob/main/libs/mf-tools/tutorial/index.md).
2329

2430
## Providing a Web Component with Module Federation
2531

@@ -94,10 +100,10 @@ export const APP_ROUTES: Routes = [
94100
path: 'angular1',
95101
component: WebComponentWrapper,
96102
data: {
97-
remoteEntry: 'https://nice-grass-018f7d910.azurestaticapps.net/remoteEntry.js',
98-
remoteName: 'angular1',
99-
exposedModule: './web-components',
100-
elementName: 'angular1-element'
103+
remoteEntry: 'https://nice-grass-018f7d910.azurestaticapps.net/remoteEntry.js',
104+
remoteName: 'angular1',
105+
exposedModule: './web-components',
106+
elementName: 'angular1-element'
101107
} as WebComponentWrapperOptions
102108
},
103109
[...]
@@ -116,10 +122,10 @@ export const APP_ROUTES: Routes = [
116122
matcher: startsWith('angular3'),
117123
component: WebComponentWrapper,
118124
data: {
119-
remoteEntry: 'https://gray-river-0b8c23a10.azurestaticapps.net/remoteEntry.js',
120-
remoteName: 'angular3',
121-
exposedModule: './web-components',
122-
elementName: 'angular3-element'
125+
remoteEntry: 'https://gray-river-0b8c23a10.azurestaticapps.net/remoteEntry.js',
126+
remoteName: 'angular3',
127+
exposedModule: './web-components',
128+
elementName: 'angular3-element'
123129
} as WebComponentWrapperOptions
124130
},
125131
[...]

libs/mf-tools/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@angular-architects/module-federation-tools",
3-
"version": "12.2.0",
3+
"version": "12.2.1",
44
"license": "MIT",
55
"peerDependencies": {
66
"@angular/common": ">=11.0.0",

libs/mf-tools/tutorial/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
This tutorial is an **extension** for the ``@angular-architects/module-federation`` tutorial [here](https://github.com/angular-architects/module-federation-plugin/blob/main/libs/mf/tutorial/tutorial.md) and shows, how to use the add-on lib ``@angular-architects/module-federation-tools`` to load web components exposed via module federation.
44

5+
## Getting Started
6+
7+
### Option A: Start with the Upstream Tutorial
8+
9+
Please find the upstream tutorial this tutorial extends [here](https://github.com/angular-architects/module-federation-plugin/blob/main/libs/mf/tutorial/tutorial.md).
10+
11+
### Option B: Checkout the Starter Kit
12+
13+
If you don't want to do the upstream tutorial first, you can use [this example](https://github.com/manfredsteyer/module-federation-plugin-example) (see main branch) as the starting point.
14+
15+
516
## Part 1: Routing to Web Components
617

718
1. Install ``@angular-architects/module-federation-tools``:

0 commit comments

Comments
 (0)