madong-code/madong-aura

选用指南

AI 根据 README 整理 · 2026/10/14 19:31:11

适用场景

适合开发后台管理系统，可直接使用内置 Mock 接口学习或切换真实后端，无需修改前端代码。

查看 README 依据

**切换真实后端：** 将 `.env.development` 中的 `VITE_NITRO_MOCK` 设为 `false`，代理目标指向真实后端（默认 `http://127.0.0.1:8500`），无需修改前端代码。 ### 📂 目录结构 ``` madong-aura/ ├── build/plugins/ # Vite 构建插件（Nitro Mock 自动拉起、UMD 静态资源处理） ├── tooling/mock/ # Nitro Mock 服务（:5320，接口契约对齐 adminapi） │ ├── handlers/ # 路由处理器（auth / system / plugin / content …） │ └── utils/admin/ # Mock 数据集、菜单种子、JWT 工具 ├── lib/ # 外部设计器静态产物 │ ├── visual-form/ # VForm3 UMD 表单设计器 │ └── visual-flow/ # LogicFlow ESM 流程设计器 ├── public/ # 静态资源（favicon、logo） └── src/

| BasicLayout | `BasicLayout` | 框架内置布局（根节点专用，**不得带 `meta.module`**） | **生产环境：** 后端安装插件时自动写入 `sys_menu` 并注入 `meta.module = '<plugin-name>'`，前端从 `GET /system/auth/user-menus` 获取菜单后由插件扫描器动态加载组件。 **开发环境：** 插件可在 `routes/index.ts` 中静态声明路由（见 demo 插件），无需后端配置即可预览。 **插件市场 API：** `src/api/app/plugin/market/` 提供模块市场列表、安装、购买等接口类型。 ### 🧪 Mock 开发 本项目使用 Nitro 提供完整的 Mock 服务，接口契约与 MaDong Admin 真实后端（adminapi）完全对齐，切换后端时无需修改前端代码。 详细约定与开发指南请参考 [tooling/mock/README.md](./tooling/mock/README.md)。 核心要点： - **响应信封：** `{ code: 0, msg: 'ok', data: ... }`，列表接口返回 `{ items, total }`

使用方式

通过命令行启动，提供开发和生产构建模式，支持独立域名或同域子路径部署，默认登录 admin/123456。

查看 README 依据

| 路由 | Vue Router 4 | | 网络 | Axios | ### 🚀 快速开始 **环境要求：** Node.js >= 22 · pnpm >= 10 ```bash # 安装依赖 pnpm install # 启动开发（前端 :5500 + Mock :5320 自动拉起） pnpm dev ``` **默认登录：** `admin / 123456`（用户名参数为 `user_name`） 手动 Mock 命令： ```bash pnpm mock # 单独启动 Mock 服务器 pnpm mock:build # 构建 Mock 产物 ``` ### 📦 构建与部署 | 模式 | 命令 | base | API | 场景 | | --- | --- | --- | --- | --- | | 开发 | `pnpm dev` | `/` | Mock `:5320` | 本地开发 · 学习 | | 生产（独立域名） | `pnpm build` | `/` | `/adminapi`（网关转发） | 独立部署 | | 生产（同域） | `pnpm build:integrated` | `/admin/` | 相对 `/adminapi` | 嵌入 PHP 项目子路径 |

部署要求

需要 Node.js >= 22 和 pnpm >= 10。

查看 README 依据

| 路由 | Vue Router 4 | | 网络 | Axios | ### 🚀 快速开始 **环境要求：** Node.js >= 22 · pnpm >= 10 ```bash # 安装依赖 pnpm install # 启动开发（前端 :5500 + Mock :5320 自动拉起） pnpm dev ``` **默认登录：** `admin / 123456`（用户名参数为 `user_name`） 手动 Mock 命令： ```bash pnpm mock # 单独启动 Mock 服务器 pnpm mock:build # 构建 Mock 产物 ``` ### 📦 构建与部署 | 模式 | 命令 | base | API | 场景 | | --- | --- | --- | --- | --- | | 开发 | `pnpm dev` | `/` | Mock `:5320` | 本地开发 · 学习 | | 生产（独立域名） | `pnpm build` | `/` | `/adminapi`（网关转发） | 独立部署 | | 生产（同域） | `pnpm build:integrated` | `/admin/` | 相对 `/adminapi` | 嵌入 PHP 项目子路径 |

已知限制

生产环境插件路由由后端菜单驱动，开发环境插件需声明路由。

查看 README 依据

| BasicLayout | `BasicLayout` | 框架内置布局（根节点专用，**不得带 `meta.module`**） | **生产环境：** 后端安装插件时自动写入 `sys_menu` 并注入 `meta.module = '<plugin-name>'`，前端从 `GET /system/auth/user-menus` 获取菜单后由插件扫描器动态加载组件。 **开发环境：** 插件可在 `routes/index.ts` 中静态声明路由（见 demo 插件），无需后端配置即可预览。 **插件市场 API：** `src/api/app/plugin/market/` 提供模块市场列表、安装、购买等接口类型。 ### 🧪 Mock 开发 本项目使用 Nitro 提供完整的 Mock 服务，接口契约与 MaDong Admin 真实后端（adminapi）完全对齐，切换后端时无需修改前端代码。 详细约定与开发指南请参考 [tooling/mock/README.md](./tooling/mock/README.md)。 核心要点： - **响应信封：** `{ code: 0, msg: 'ok', data: ... }`，列表接口返回 `{ items, total }`