72 lines
2.1 KiB
Markdown
72 lines
2.1 KiB
Markdown
# Vben Admin 项目
|
||
|
||
## 📌 项目简介
|
||
Vben Admin 是一个基于现代前端技术栈的开源中后台管理系统模板，提供了一系列企业级 UI 组件和功能模块，旨在帮助开发者快速搭建高效、美观的管理后台。
|
||
|
||
## 🧩 技术栈
|
||
- **前端框架**: Vue 3
|
||
- **UI 框架**: Ant Design Vue
|
||
- **构建工具**: Vite
|
||
- **状态管理**: Pinia
|
||
- **代码规范**: ESLint, Prettier
|
||
- **其他**: TypeScript, Axios, Vue Router
|
||
|
||
## 📁 项目结构
|
||
```
|
||
apps/web-antd/
|
||
├── public/ # 静态资源文件
|
||
│ └── tinymce/ # 富文本编辑器相关资源
|
||
├── index.html # 入口 HTML 文件
|
||
├── package.json # 项目依赖及脚本配置
|
||
└── .env* # 环境变量配置文件
|
||
```
|
||
|
||
## 🚀 开发启动
|
||
请确保你已经安装了 Node.js 和 npm/yarn/pnpm。
|
||
|
||
### 安装依赖
|
||
```bash
|
||
npm install
|
||
# 或者使用 yarn
|
||
yarn install
|
||
```
|
||
|
||
### 启动开发服务器
|
||
```bash
|
||
npm run dev
|
||
# 或者
|
||
yarn dev
|
||
```
|
||
|
||
### 构建生产版本
|
||
```bash
|
||
npm run build
|
||
# 或者
|
||
yarn build
|
||
```
|
||
|
||
## 📦 功能模块
|
||
- **用户认证**: 登录、登出、权限控制
|
||
- **菜单系统**: 动态路由与菜单生成
|
||
- **数据表格**: 支持分页、筛选、排序等功能
|
||
- **表单验证**: 基于 Vue Hook Form 的表单验证机制
|
||
- **富文本编辑器**: 集成 TinyMCE 编辑器
|
||
- **Mock 数据服务**: 提供本地模拟后端接口服务
|
||
|
||
## 📚 使用文档
|
||
详细文档请参考：
|
||
- [贡献指南](.github/contributing.md)
|
||
- [代码提交规范](.github/commit-convention.md)
|
||
|
||
## 🤝 贡献代码
|
||
欢迎任何形式的贡献！请先阅读我们的[贡献指南](.github/contributing.md)以了解如何参与项目开发。
|
||
|
||
## 📜 开源协议
|
||
本项目采用 MIT License，请查看 [LICENSE](LICENSE) 文件了解更多详情。
|
||
|
||
## 📬 联系我们
|
||
如有合作或定制开发需求，请扫码联系（非项目咨询请勿扰）。
|
||
|
||
---
|
||
|
||
> ⚠️ 注意：本项目为纯开源项目，无任何商业版本。所有功能均免费开放使用。 |