From 1cef1684efe8c8c0c3a35155dd05c51dc59a81f1 Mon Sep 17 00:00:00 2001 From: pany <939630029@qq.com> Date: Thu, 5 Dec 2024 11:53:53 +0800 Subject: [PATCH] =?UTF-8?q?docs:=205.0=20=E4=B8=AD=E6=96=87=E8=87=AA?= =?UTF-8?q?=E8=BF=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.zh-CN.md | 230 ++++++++++++++++++++++++++++++------------------ 1 file changed, 142 insertions(+), 88 deletions(-) diff --git a/README.zh-CN.md b/README.zh-CN.md index c000cee..93aa939 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,72 +1,45 @@
V3 Admin Vite Logo

V3 Admin Vite

- English | 中文
-## ⚡ 简介 +English | 中文 -V3 Admin Vite 是一个免费开源的中后台管理系统基础解决方案，基于 Vue3、TypeScript、Element Plus、Pinia 和 Vite 等主流技术 +> [!NOTE] +> 为爱发电 +> +> 完全免费，但希望你点一个 Star 支持一下！ -- Vue Cli 5.x 版: [v3-admin](https://github.com/un-pany/v3-admin) -- Electron 桌面版: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite) +> [!IMPORTANT] +> 全新 5.0 版本 +> +> 欢迎体验全新的 5.0 版本，目前正在 beta 阶段 -国内仓库：[Gitee](https://gitee.com/un-pany/v3-admin-vite) +> [!WARNING] +> 4.x 版本 +> +> [4.x 分支](https://github.com/un-pany/v3-admin-vite/tree/4.x)如果没有严重的 BUG 将不再维护 -## 📚 文档 +## 简介 -- 中文文档：[链接](https://juejin.cn/post/7089377403717287972) -- 手摸手教程：[链接](https://juejin.cn/column/7207659644487139387) +V3 Admin Vite 是一个免费开源的中后台管理系统基础解决方案，基于 Vue3、Vite、TypeScript、Element Plus 等主流技术 -## 📺 在线预览 +## 使用 -| 位置 | 账号 | 链接 | -| ------------ | --------------- | ----------------------------------------------- | -| github-pages | admin 或 editor | [链接](https://un-pany.github.io/v3-admin-vite) | +
+推荐环境 -## ❤️ 用爱发电 +- 新版 Visual Studio Code +- 安装 .vscode/extensions.json 文件中推荐的插件 +- node 20.x 或 22+ +- pnpm 9+ -- **完全免费**：但希望你点一个 star ！！！ -- **非常简洁**：没有复杂的封装，没有复杂的类型体操，开箱即用 -- **详细的注释**：各个配置项都写有尽可能详细的注释 -- **最新的依赖**: 定期更新所有三方依赖至最新版 -- **有一点规整**: 代码风格统一，命名风格统一，注释风格统一 +
-## 特性 - -- **Vue3**：采用 Vue3 + script setup 最新的 Vue3 组合式 API -- **Element Plus**：Element UI 的 Vue3 版本 -- **Pinia**: 传说中的 Vuex5 -- **Vite**：真的很快 -- **Vue Router**：路由路由 -- **TypeScript**：JavaScript 语言的超集 -- **pnpm**：更快速的，节省磁盘空间的包管理工具 -- **Scss**：和 Element Plus 保持一致 -- **CSS 变量**：主要控制项目的布局和颜色 -- **ESlint**：代码校验与格式化 -- **Axios**：发送网络请求（已封装好） -- **UnoCSS**：具有高性能且极具灵活性的即时原子化 CSS 引擎 -- **兼容移动端**: 布局兼容移动端页面分辨率 - -## 功能 - -- **用户管理**：登录、登出演示 -- **权限管理**：页面级权限（动态路由）、按钮级权限（指令权限、权限函数）、路由守卫 -- **多环境**：开发环境（development）、预发布环境（staging）、生产环境（production） -- **多主题**：普通、黑暗、深蓝, 三种主题模式 -- **多布局**：左侧、顶部、混合, 三种布局模式 -- **错误页面**: 403、404 -- **Dashboard**：根据不同用户显示不同的 Dashboard 页面 -- **其他内置功能**：SVG、动态侧边栏、动态面包屑、标签页快捷导航、Screenfull 全屏、自适应收缩侧边栏、Composable - -## 🚀 开发 +
+开发 ```bash -# 配置 -1. 一键安装 .vscode 目录中推荐的插件 -2. node 版本 18.x 或 20+ -3. pnpm 版本 8.x 或最新版 - # 克隆项目 git clone https://github.com/un-pany/v3-admin-vite.git @@ -80,7 +53,10 @@ pnpm i pnpm dev ``` -## 📦️ 多环境打包构建 +
+ +
+打包构建 ```bash # 打包构建预发布环境 @@ -90,64 +66,142 @@ pnpm build:staging pnpm build ``` -## ✔️ 预览 +
+ +
+本地预览 ```bash # 先执行打包构建命令生成 dist 目录后再执行以下预览命令 pnpm preview ``` -## 🔧 代码检查 +
+ +
+代码检查 ```bash -# 代码格式化 +# 代码校验与格式化 pnpm lint # 单元测试 pnpm test ``` -## Git 提交规范参考 +
-- `feat` 新功能 -- `fix` 修复错误 -- `perf` 优化 -- `refactor` 重构代码 -- `docs` 文档和注释 -- `types` 类型相关 -- `test` 单测相关 -- `ci` 持续集成、工作流 -- `revert` 撤销更改 -- `chore` 琐事（更新依赖、修改配置等） +
+Git 提交规范 + +`feat` 新功能 + +`fix` 修复错误 + +`perf` 优化 + +`refactor` 重构代码 + +`docs` 文档和注释 + +`types` 类型相关 + +`test` 单测相关 + +`ci` 持续集成、工作流 + +`revert` 撤销更改 + +`chore` 琐事（更新依赖、修改配置等） + +
+ +## 链接 + +在线预览：[github-pages](https://un-pany.github.io/v3-admin-vite) + +中文文档：[链接](https://juejin.cn/post/7089377403717287972) + +零基础教程：[链接](https://juejin.cn/column/7207659644487139387) + +Electron 桌面版: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite) + +国内仓库：[gitee](https://gitee.com/un-pany/v3-admin-vite) + +可有可无的群：[查看进群方式](https://github.com/un-pany/v3-admin-vite/issues/191) + +捐赠：[请作者喝咖啡](https://github.com/un-pany/v3-admin-vite/issues/69) + +## 特性 + +**结构精简**：没有复杂的封装，没有复杂的类型体操，刚好够用 + +**详细的注释**：各个配置项都写有尽可能详细的注释 + +**最新的依赖**: 及时更新所有三方依赖至最新版 + +**有一点规范**: 代码风格统一，命名风格统一，注释风格统一 + +## 技术栈 + +**Vue3**：采用 Vue3 + script setup 最新的 Vue3 组合式 API + +**Element Plus**：Element UI 的 Vue3 版本 + +**Pinia**: 传说中的 Vuex5 + +**Vite**：真的很快 + +**Vue Router**：路由路由 + +**TypeScript**：JavaScript 语言的超集 + +**pnpm**：更快速的，节省磁盘空间的包管理工具 + +**Scss**：和 Element Plus 保持一致 + +**CSS 变量**：主要控制项目的布局和颜色 + +**ESlint**：代码校验与格式化 + +**Axios**：发送网络请求（已封装好） + +**UnoCSS**：具有高性能且极具灵活性的即时原子化 CSS 引擎 + +## 内置功能 + +**用户管理**：登录、登出演示 + +**权限管理**：页面级权限（动态路由）、按钮级权限（指令权限、权限函数）、路由守卫 + +**多环境**：开发环境（development）、预发布环境（staging）、生产环境（production） + +**多主题**：普通、黑暗、深蓝, 三种主题模式 + +**多布局**：左侧、顶部、混合, 三种布局模式 + +**首页**：根据不同用户显示不同的 Dashboard 页面 + +**错误页**: 403、404 + +**兼容移动端**: 布局兼容移动端页面分辨率 + +**其他**：SVG 雪碧图、动态侧边栏、动态面包屑、标签页快捷导航、内容区放大与全屏、组合式函数 ## 项目预览图 -![preview1.png](./src/common/assets/images/docs/preview1.png) -![preview2.png](./src/common/assets/images/docs/preview2.png) -![preview3.png](./src/common/assets/images/docs/preview3.png) +![preview1](./src/common/assets/images/docs/preview1.png) +![preview2](./src/common/assets/images/docs/preview2.png) +![preview3](./src/common/assets/images/docs/preview3.png) -## 💕 贡献者 +## 贡献者 -感谢所有的贡献者！ +在此感谢所有的贡献者！ -## 💕 感谢 Star +## Licens -小项目获取 star 不易，如果你喜欢这个项目的话，欢迎支持一个 star！这是作者持续维护的唯一动力（小声：毕竟是免费的） - -## ☕ Donate - -[查看捐赠方式](https://github.com/un-pany/v3-admin-vite/issues/69) - -## 可有可无的群 - -[查看进群方式](https://github.com/un-pany/v3-admin-vite/issues/191) - -## 📄 License - -[MIT](./LICENSE) - -Copyright (c) 2022-present [pany](https://github.com/pany-ang) +[MIT](./LICENSE) License © 2022-PRESENT [pany](https://github.com/pany-ang)