From 369e88e2e8fc3875f669df5b99e85419d086504f Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 20 Jun 2025 01:43:35 +0000 Subject: [PATCH] Update README.md --- apps/web-naive/src/locales/README.md | 73 +++++++++++++++++++++++++++- 1 file changed, 71 insertions(+), 2 deletions(-) diff --git a/apps/web-naive/src/locales/README.md b/apps/web-naive/src/locales/README.md index 7b451032e..5e06c5970 100644 --- a/apps/web-naive/src/locales/README.md +++ b/apps/web-naive/src/locales/README.md @@ -1,3 +1,72 @@ -# locale +# Vben Admin 项目 -每个app使用的国际化可能不同,这里用于扩展国际化的功能,例如扩展 dayjs、antd组件库的多语言切换,以及app本身的国际化文件。 +## 📌 项目简介 +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) 文件了解更多详情。 + +## 📬 联系我们 +如有合作或定制开发需求,请扫码联系(非项目咨询请勿扰)。 + +--- + +> ⚠️ 注意:本项目为纯开源项目,无任何商业版本。所有功能均免费开放使用。 \ No newline at end of file