Files
admin-vben/README.md

108 lines
3.0 KiB
Markdown
Raw Normal View History

# aiotagro-ui-admin-vben - 企业级管理系统框架
2024-05-19 21:20:42 +08:00
## 项目简介
2024-05-19 21:20:42 +08:00
aiotagro-ui-admin-vben 是基于 Vue3 + TypeScript + Vite 的现代化企业级管理系统框架,采用 monorepo 架构,提供完整的前端解决方案。
2024-05-19 21:20:42 +08:00
## 核心特性
- 🚀 **现代化技术栈**Vue3 + TypeScript + Vite + Pinia
- 📦 **Monorepo 架构**:基于 pnpm + turbo 的高效开发体验
- 🎨 **多主题支持**Ant Design、Element Plus、Naive UI 三套 UI 组件库
- 🔧 **完整工具链**ESLint、Prettier、StyleLint、TypeScript 检查
- 📱 **响应式设计**:完美适配桌面端和移动端
- 🌐 **国际化支持**:内置多语言解决方案
- 🔐 **权限管理**:完整的 RBAC 权限控制系统
2024-05-19 21:20:42 +08:00
## 项目结构
2024-05-19 21:20:42 +08:00
```
aiotagro-ui-admin-vben/
├── apps/ # 应用目录
│ ├── web-antd/ # Ant Design 版本
│ ├── web-ele/ # Element Plus 版本
│ ├── web-naive/ # Naive UI 版本
│ └── backend-mock/ # 后端模拟服务
├── packages/ # 共享包目录
│ ├── @core/ # 核心功能包
│ ├── constants/ # 常量定义
│ ├── effects/ # 副作用管理
│ ├── icons/ # 图标库
│ ├── locales/ # 国际化资源
│ ├── stores/ # 状态管理
│ ├── styles/ # 样式文件
│ ├── types/ # 类型定义
│ └── utils/ # 工具函数
├── internal/ # 内部配置
│ ├── lint-configs/ # 代码规范配置
│ ├── tailwind-config/ # Tailwind 配置
│ ├── tsconfig/ # TypeScript 配置
│ └── vite-config/ # Vite 配置
├── docs/ # 项目文档
├── playground/ # 开发测试环境
└── scripts/ # 脚本工具
```
2024-05-19 21:20:42 +08:00
## 快速开始
2024-07-28 17:16:50 +08:00
### 环境要求
2024-07-28 17:16:50 +08:00
- Node.js >= 18.0.0
- pnpm >= 8.0.0
2024-05-19 21:20:42 +08:00
### 安装依赖
2024-05-19 21:20:42 +08:00
```bash
# 安装 pnpm
npm install -g pnpm
2024-05-19 21:20:42 +08:00
# 安装项目依赖
pnpm install
```
2024-05-19 21:20:42 +08:00
### 开发运行
```bash
# 启动 Ant Design 版本
pnpm dev:antd
# 启动 Element Plus 版本
pnpm dev:ele
# 启动 Naive UI 版本
pnpm dev:naive
```
### 构建项目
```bash
# 构建所有应用
pnpm build
# 构建指定应用
pnpm build:antd
pnpm build:ele
pnpm build:naive
```
## 文档目录
详细文档请查看 [docs/](./docs/) 目录:
- [📚 技术文档](./docs/) - 开发指南、API 文档
- [👥 用户手册](./docs/user-guide/) - 系统使用说明
- [🚀 部署指南](./docs/deployment/) - 生产环境部署
- [🔧 运维手册](./docs/operations/) - 系统维护指南
## 贡献指南
欢迎提交 Issue 和 Pull Request请阅读 [贡献指南](./docs/contributing.md) 了解详细流程。
## 许可证
本项目基于 MIT 许可证开源。
## 联系方式
- 项目主页https://github.com/vbenjs/vue-vben-admin
- 问题反馈https://github.com/vbenjs/vue-vben-admin/issues