|
1 | | -# ModuleFederation |
| 1 | +<p align="center"> |
| 2 | + <img alt="Module federation Banner" width="260" src="https://github.com/module-federation/universe/assets/27547179/11234712-40fc-4696-a7fd-16e0c631005a"> |
| 3 | +</p> |
2 | 4 |
|
3 | | -# Documentation |
| 5 | +# Module Federation |
4 | 6 |
|
5 | | -[module-federation/nextjs-mf](./packages/nextjs-mf) |
| 7 | +## 💡 What is Module Federation? |
6 | 8 |
|
7 | | -[module-federation/node](./packages/node) |
| 9 | +- Module Federation is a concept that allows developers to share code and resources across multiple JavaScript applications |
8 | 10 |
|
9 | | -[module-federation/utilities](./packages/utilities) |
| 11 | +- Module Federation can be used to split monolithic applications into micro-front-end architectures |
10 | 12 |
|
11 | | -[module-federation/typescript](./packages/typescript) |
| 13 | +- Module Federation reuses common dependencies between modules as much as possible |
12 | 14 |
|
13 | | -[module-federation/storybook-addon](./packages/storybook-addon) |
| 15 | +[Learn more](https://module-federation.io/docs/en/mf-docs/0.2/getting-started/) |
14 | 16 |
|
15 | | -[module-federation/native-federation-typescript](./packages/native-federation-typescript) |
| 17 | +## 🔥 What does universe offer? |
16 | 18 |
|
17 | | -[module-federation/native-federation-tests](./packages/native-federation-tests) |
| 19 | +The universe repository provides a set of tools to enhance module federation's capabilities. These include: |
18 | 20 |
|
19 | | -## Generate an application |
| 21 | +- [Next.js Module Federation](./packages/nextjs-mf) |
| 22 | +- [Node Module Federation](./packages/node) |
| 23 | +- [Storybook addon for Module Federation](./packages/storybook-addon) |
| 24 | +- [Native federation typescript](./packages/native-federation-typescript) |
| 25 | +- [Utilities](./packages/utilities) |
20 | 26 |
|
21 | | -Run `nx g @nx/next:app my-app` to generate an application. |
| 27 | +# 🧑💻 Community |
22 | 28 |
|
23 | | -> You can use any of the plugins above to generate applications as well. |
| 29 | +Come and chat with us on [Discord](https://discord.com/invite/T8c6yAxkbv)! The Module federation team and users are active there, and we're always looking for contributions. |
24 | 30 |
|
25 | | -When using Nx, you can create multiple applications and libraries in the same workspace. |
| 31 | +# 🤝 Contribution |
26 | 32 |
|
27 | | -## Generate a library |
| 33 | +> New contributors welcome! |
28 | 34 |
|
29 | | -Run `nx g @nx/js:lib my-lib` to generate a library. |
| 35 | +Please read the [Contributing Guide](https://github.com/module-federation/universe/tree/canary). |
30 | 36 |
|
31 | | -> You can also use any of the plugins above to generate libraries as well. |
| 37 | +## 🙌 Code of Conduct |
32 | 38 |
|
33 | | -Libraries are shareable across libraries and applications. They can be imported from `@module-federation/mylib`. |
34 | | - |
35 | | -## Development server |
36 | | - |
37 | | -Run `nx serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. |
38 | | - |
39 | | -## Build |
40 | | - |
41 | | -Run `nx build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. |
42 | | - |
43 | | -## Running unit tests |
44 | | - |
45 | | -Run `nx test my-app` to execute the unit tests via [Jest](https://jestjs.io). |
46 | | - |
47 | | -Run `nx affected:test` to execute the unit tests affected by a change. |
48 | | - |
49 | | -## Social links |
50 | | - |
51 | | -We are excited to announce the new [Discord community](https://discord.gg/T8c6yAxkbv) for Module Federation has been recently launched! This space will be used to discuss and share knowledge about the latest advancements in module federation and how to use it effectively. See you there! |
| 39 | +This repo has adopted the Code of Conduct. Please check [Code of Conduct](./CODE_OF_CONDUCT.md) for more details. |
0 commit comments