@multisystemsuite/create-mf-app 1.0.9 → 1.0.11

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 CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  **`@multisystemsuite/create-mf-app`** — TypeScript CLI that scaffolds production-grade **enterprise microfrontend platforms** using React 19, Vite 7, Module Federation, React Router, Material UI, Docker, and npm workspaces.
4
4
 
5
- Inspired by **Nx**, **Turborepo**, **Backstage**, and **Module Federation** — optimized for React microfrontends, Vite, runtime federation, SaaS dashboards, and internal developer platforms.
5
+ Inspired by **Module Federation** — optimized for React microfrontends, Vite, runtime federation, SaaS dashboards, and internal developer platforms.
6
6
 
7
7
  ---
8
8
 
@@ -104,7 +104,7 @@ Then use the scripts in [How to use the generated project](#how-to-use-the-gener
104
104
  - **`apps/<child>`** — federated remotes (names you pass in `--children`)
105
105
  - **`apps/corelib`** (or custom `--shared` name) — shared federated library (design system, RBAC, UI)
106
106
  - **`packages/*`** — shared npm workspace libraries
107
- - **`tools/mf-cli`** — Nx-like platform CLI (`mf generate`, `mf graph`, `mf affected`, …)
107
+ - **`tools/mf-cli`** — MF platform CLI (`mf generate`, `mf graph`, `mf affected`, …)
108
108
  - **`task-runner/`** — parallel builds + hash cache (`.mf/cache`)
109
109
  - **`plugins/`** — React, Vite, Federation, MUI, Auth, Charts, Workflow, Monitoring
110
110
  - **`devtools/`** — federation inspector, profiler, theme inspector
@@ -374,11 +374,11 @@ npx @multisystemsuite/create-mf-app my-control-plane --control-plane -y
374
374
  | **Services** | `services/control-plane-api` (Express + Socket.IO + MongoDB) |
375
375
  | **UI** | React Flow designer, real-time monitor, registry, deployments, analytics, environments |
376
376
 
377
- ![Enterprise Federation Control Plane — Workflow Designer](docs/images/control-plane-workflow-designer.png)
377
+ ![Enterprise Federation Control Plane — Workflow Designer](https://unpkg.com/@multisystemsuite/create-mf-app/docs/images/control-plane-workflow-designer.png)
378
378
 
379
379
  *Workflow Designer tab at `http://localhost:3004` (or via shell at `/workflow-monitor-app`) — federation topology with live node health, auto-layout, and save/scan controls.*
380
380
 
381
- ![Enterprise Federation Control Plane — Federation Monitor](docs/images/control-plane-federation-monitor.png)
381
+ ![Enterprise Federation Control Plane — Federation Monitor](https://unpkg.com/@multisystemsuite/create-mf-app/docs/images/control-plane-federation-monitor.png)
382
382
 
383
383
  *Federation Monitor tab — healthy/unhealthy summary cards and real-time remote health stream (Socket.IO from control-plane API on `:4000`).*
384
384
 
@@ -478,7 +478,7 @@ my-platform/
478
478
  │ ├── compose/docker-compose.yml
479
479
  │ ├── kubernetes/ingress.yaml
480
480
  │ └── scripts/generate-routing.js
481
- ├── mf.json # Workspace config (like nx.json)
481
+ ├── mf.json # Workspace project registry, tags, and federation config
482
482
  ├── apps/
483
483
  │ ├── main/ # Host shell (port 3000)
484
484
  │ ├── billing/ # Child remote (your --children names)
@@ -1082,10 +1082,10 @@ localStorage.removeItem('mf-enterprise-config')
1082
1082
  For **contributors** working on the CLI itself (this repo):
1083
1083
 
1084
1084
  ```bash
1085
- git clone https://github.com/your-org/create-mf-app
1085
+ git clone https://github.com/Abhishek2122/create-mf-app
1086
1086
  cd create-mf-app
1087
1087
  npm install
1088
- npm run build # tsup → dist/
1088
+ npm run build # tsup → dist/ + copy docs/ → dist/docs/
1089
1089
  npm run dev # run dist/index.js locally (pass args after --)
1090
1090
 
1091
1091
  # test generator changes locally (uses dist/, not published npm)
@@ -1108,7 +1108,9 @@ npm publish --access public
1108
1108
 
1109
1109
  **Package name:** `@multisystemsuite/create-mf-app`
1110
1110
  **Binary:** `create-mf-app`
1111
- **Published files:** `dist/`, `README.md`
1111
+ **Published files:** `dist/` (includes `dist/docs/`), `docs/` (README screenshots), `README.md`
1112
+
1113
+ **README images:** served from the published npm package via [unpkg](https://unpkg.com) (`docs/images/`). After changing screenshots, run `npm run rebuild`, publish, then commit `docs/images/` to GitHub.
1112
1114
 
1113
1115
  ---
1114
1116
 
package/dist/index.js CHANGED
@@ -7303,7 +7303,7 @@ var VSCODE_SNIPPETS = `{
7303
7303
  function getPlatformArchitectureDoc(projectName) {
7304
7304
  return `# Platform Architecture \u2014 ${projectName}
7305
7305
 
7306
- Next-generation enterprise frontend platform: **Nx + Turborepo + Module Federation + Backstage**, optimized for React 19 and Vite 7.
7306
+ Next-generation enterprise frontend platform: **Module Federation + MF Platform CLI + enterprise governance**, optimized for React 19 and Vite 7.
7307
7307
 
7308
7308
  ## Platform stack
7309
7309
 
@@ -7366,7 +7366,7 @@ flowchart TB
7366
7366
 
7367
7367
  ## Monorepo governance
7368
7368
 
7369
- - **mf.json** \u2014 project registry, tags, target defaults (like nx.json)
7369
+ - **mf.json** \u2014 project registry, tags, target defaults for the monorepo
7370
7370
  - **governance/module-boundaries.json** \u2014 import boundary rules
7371
7371
  - **governance/CODEOWNERS** \u2014 team ownership
7372
7372
  - Tags: \`type:host\`, \`type:remote\`, \`type:lib\`, \`scope:corelib\`
@@ -7420,7 +7420,7 @@ flowchart TB
7420
7420
  - Publish shared libs as versioned packages
7421
7421
  - Use remote cache (S3/GCS) for \`.mf/cache\` in CI
7422
7422
  - CDN + edge for static remoteEntry assets
7423
- - Backstage software catalog integration for service discovery
7423
+ - Federation registry (\`apps/corelib/src/federation/\`) for remote/service discovery
7424
7424
 
7425
7425
  ---
7426
7426
  Generated by [create-mf-app](https://github.com/multisystemsuite/create-mf-app).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@multisystemsuite/create-mf-app",
3
- "version": "1.0.9",
3
+ "version": "1.0.11",
4
4
  "description": "Production-ready TypeScript CLI to scaffold enterprise microfrontend apps with React, Vite and Module Federation.",
5
5
  "license": "MIT",
6
6
  "keywords": [
@@ -20,11 +20,12 @@
20
20
  "type": "commonjs",
21
21
  "files": [
22
22
  "dist",
23
- "README.md"
23
+ "README.md",
24
+ "docs"
24
25
  ],
25
26
  "scripts": {
26
27
  "clean": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\"",
27
- "build": "tsup",
28
+ "build": "tsup && node scripts/copy-docs.js",
28
29
  "dev": "node dist/index.js",
29
30
  "rebuild": "npm run clean && npm run build",
30
31
  "pack:check": "npm pack",