create-synapse-mfe 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# create-synapse-mfe 🚀
|
|
2
|
+
|
|
3
|
+
A lightning-fast, zero-dependency CLI scaffolding tool for bootstrapping a modern, scalable **Micro-Frontend (MFE)** architecture using **Vite**, **React**, and **Module Federation**.
|
|
4
|
+
|
|
5
|
+
## 🌟 Features
|
|
6
|
+
|
|
7
|
+
- **Zero Dependencies**: Built with native Node.js (`child_process`, `fs`) for instant execution.
|
|
8
|
+
- **Vite & Module Federation**: Pre-configured for high-performance React applications.
|
|
9
|
+
- **Enterprise Ready**: Includes a Host (Shell) app, Remote apps, and shared libraries out of the box.
|
|
10
|
+
- **Nx Monorepo Style**: Organized for scalable development.
|
|
11
|
+
|
|
12
|
+
## 📦 Usage
|
|
13
|
+
|
|
14
|
+
You do not need to install this package globally. Simply run it directly using `npx`:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx create-synapse-mfe@latest
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
The CLI will interactively ask for your project name (default: `synapse-workspace`).
|
|
21
|
+
|
|
22
|
+
### Example
|
|
23
|
+
```bash
|
|
24
|
+
npx create-synapse-mfe@latest my-awesome-mfe
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 🛠️ Next Steps After Scaffolding
|
|
28
|
+
|
|
29
|
+
Once your project is generated, follow these simple steps to spin up the entire Micro-Frontend ecosystem:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# 1. Navigate into your new project
|
|
33
|
+
cd my-awesome-mfe
|
|
34
|
+
|
|
35
|
+
# 2. Install dependencies (pnpm is highly recommended)
|
|
36
|
+
pnpm install
|
|
37
|
+
|
|
38
|
+
# 3. Start the entire MFE network (Shell + Remotes) in parallel
|
|
39
|
+
pnpm run dev:new
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## 🏗️ Architecture Blueprint
|
|
43
|
+
|
|
44
|
+
The generated workspace pulls from a clean-slate boilerplate that includes:
|
|
45
|
+
- `apps/shell`: The main host application router.
|
|
46
|
+
- `apps/auth-mfe`: A remote micro-frontend handling authentication.
|
|
47
|
+
- `apps/docs-mfe`: A remote documentation micro-frontend.
|
|
48
|
+
- `libs/`: Shared libraries holding UI components, types, and API logic.
|
|
49
|
+
|
|
50
|
+
## 📄 License
|
|
51
|
+
MIT
|