65 lines
4.6 KiB
Markdown
65 lines
4.6 KiB
Markdown
# Business Center Vite
|
||
|
||
> 【注意】当前项目尚处于早期开发阶段，不建议生产使用。
|
||
|
||
business-center-vite 是一个开源免费，含前后端的后台管理模板
|
||
|
||
前端技术栈：`Vue`， `Vite`，`Element Plus`，`Pinia`，`TypeScript`
|
||
|
||
## 项目结构
|
||
|
||
项目代码使用 monorepo 管理（即整个项目代码都在主仓库维护），子仓库仅定期同步代码，如您只需要前端/后端模板，可以使用子仓库代码。
|
||
|
||
```
|
||
business-center-vite (主仓库 business-center-vite)
|
||
├─ frontend ------------------------------- 项目前端源码 (定期同步代码至子仓库: business-center-frontend)
|
||
│ ├─ library ---------------------------- 业务无关的库依赖文件，例如：自动导入配置等
|
||
│ │ ├─ build --------------------------
|
||
│ │ │ └─ unplugin -------------------
|
||
│ │ │ ├─ auto-imports.d.ts ------
|
||
│ │ │ └─ components.d.ts --------
|
||
│ │ └─ ...
|
||
│ ├─ public ----------------------------- 不参与 build 打包的静态文件目录
|
||
│ ├─ src
|
||
│ │ ├─ assets -------------------------
|
||
│ │ ├─ components ---------------------
|
||
│ │ ├─ router -------------------------
|
||
│ │ ├─ stores -------------------------
|
||
│ │ ├─ types --------------------------
|
||
│ │ ├─ views --------------------------
|
||
│ │ ├─ App.vue ------------------------
|
||
│ │ └─ main.ts ------------------------
|
||
│ ├─ vite.config.ts ---------------------
|
||
│ ├─ package.json ----------------------- 项目清单文件
|
||
│ ├─ ...
|
||
│ └─ README.md -------------------------- 前端自述文件
|
||
├─ backend -------------------------------- 项目后端源码 (定期同步代码至子仓库: business-center-backend)
|
||
│ ├─ ...
|
||
│ └─ README.md -------------------------- 后端自述文件
|
||
└─ README.md ------------------------------ 自述文件
|
||
```
|
||
|
||
## frontend 前端部分
|
||
|
||
### 核心依赖
|
||
|
||
| 依赖 | 版本 | 链接 | 说明 |
|
||
| --------------------------- | :----: | :----------------------------------------------------------: | ------------------------------------------------------------ |
|
||
| vue | 3.5.x | [官网](https://cn.vuejs.org/) [npm](https://www.npmjs.com/package/vue) [GitHub](https://github.com/vuejs/vue) | JavaScript 框架 |
|
||
| vite | 6.0.x | [官网](https://cn.vite.dev/) [npm](https://www.npmjs.com/package/vite) [GitHub](https://github.com/vitejs/vite) | 前端工具链 |
|
||
| element-plus | 2.9.x | [官网](https://element-plus.org/zh-CN/) [npm](https://www.npmjs.com/package/element-plus) [GitHub](https://github.com/element-plus/element-plus) | UI 组件库（使用[手动导入](https://element-plus.org/zh-CN/guide/quickstart.html#%E6%89%8B%E5%8A%A8%E5%AF%BC%E5%85%A5)方式） |
|
||
| pinia | 2.3.x | [官网](https://pinia.vuejs.org/) [npm](https://www.npmjs.com/package/pinia) [GitHub](https://github.com/vuejs/pinia) | 全局状态管理 |
|
||
| pinia-plugin-persistedstate | 4.2.x | [官网](https://prazdevs.github.io/pinia-plugin-persistedstate/zh/) [npm](https://www.npmjs.com/package/pinia-plugin-persistedstate) [GitHub](https://github.com/prazdevs/pinia-plugin-persistedstate) | Pinia 存储持久化插件 |
|
||
| vue-router | 4.5.x | [官网](https://router.vuejs.org/) [npm](https://www.npmjs.com/package/vue-router) [GitHub](https://github.com/vuejs/router) | 路由管理 |
|
||
| vue-i18n | 11.1.x | [官网](https://vue-i18n.intlify.dev/) [npm](https://www.npmjs.com/package/vue-i18n) [GitHub](https://github.com/intlify/vue-i18n) | i18n 国际化 |
|
||
| @vueuse/core | 12.7.x | [官网](https://vueuse.org/) [中文网](https://vueuse.nodejs.cn/) [npm](https://www.npmjs.com/package/@vueuse/core) [GitHub](https://github.com/vueuse/vueuse) | Vue 组合实用工具集合 |
|
||
|
||
|
||
### 命名规范
|
||
|
||
目录名使用连字符 (例如: `auto-import/`), 组件名使用大驼峰 (例如: `UserCenter.vue`)
|
||
|
||
## 贡献
|
||
|
||
请在主仓库进行 issue 或 pr 提交，子仓库仅作同步。
|