diff --git a/README.md b/README.md index e69de29..721b1a5 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,374 @@ +# Admin Framework(admin-framework) + +基于 **Vue 2**、**Vue Router 3**、**Vuex 3**、**View Design(iView 4)** 的后台管理框架:登录、布局、动态菜单与路由、权限、HTTP 封装、系统管理页面等。 + +--- + +## 1. 依赖与环境 + +### 1.1 Peer 依赖(由业务项目安装) + +框架不打包以下依赖,需在宿主项目中安装并与框架版本兼容: + +| 包 | 说明 | +|----|------| +| `vue` ^2.6 | 运行时 | +| `vue-router` ^3 | 路由 | +| `vuex` ^3 | 状态 | +| `view-design` ^4 | UI 组件库 | +| `axios` | HTTP(与框架内封装配合) | + +### 1.2 构建产物(`dist/`) + +| 文件 | 说明 | +|------|------| +| `admin-framework.js` | **UMD**,Terser 压缩,对外默认导出为框架单例;浏览器中为 `window.AdminFramework`,也可由 Webpack 等从该文件解析 `import` | + +在项目根目录执行: + +```bash +npm run build +``` + +--- + +## 2. 引入方式 + +### 2.1 与 Webpack / Vue CLI 等业务工程配合 + +先安装 peer 依赖,将构建好的 `dist/admin-framework.js` 拷贝到业务项目或通过路径引用;在入口中: + +```javascript +import AdminFramework from './vendor/admin-framework.js' +// 若已将包发布到 npm 且 package.json 的 main 指向 dist,则: +// import AdminFramework from 'admin-framework' +``` + +打包器需将 `vue`、`vue-router`、`vuex`、`view-design`、`axios` 作为外部依赖或正常解析(与 UMD 的 externals 一致)。 + +### 2.2 页面中通过 `