From f1329a46e47f4d31c8588c818754ae1a550141b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E4=BC=A0=E9=BE=99?= Date: Tue, 5 Apr 2022 17:35:05 +0800 Subject: [PATCH] docs: update readme --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6862b41..a8b8093 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -# VUE NAIVE ADMIN +## VUE NAIVE ADMIN -## 简介 +### 简介 -Vue Naive Admin，一个基于 Vue3.0、Vite、Naive UI 的轻量级后台管理模板，没有集成 TypeScript，没有集成国际化，没有集成复杂的主题配置，上手成本非常低，对新手极其友好。不过麻雀虽小五脏俱全，权限、Mock、菜单、axios 封装、pinia、项目配置、样式配置、环境配置，以及一些经常用的基础组件封装等等这些该有的都有，参考多个 vue3 后台管理模板后以最简洁优雅的方式实现，非常适用于中小型项目或者个人项目。 +[Vue Naive Admin](https://github.com/zclzone/vue-naive-admin)，一个基于 Vue3.0、Vite、Naive UI 的后台管理模板，相较于其他比较流行的后台管理模板，此项目相对简洁、轻量，学习成本非常低，对新手极其友好。不过麻雀虽小五脏俱全，权限、Mock、菜单、axios 封装、pinia、项目配置、样式配置、环境配置，以及一些经常用的基础组件封装等等这些该有的都有，非常适用于中小型项目或者个人项目，也可此模板进行二次封装改造用于大型项目。 -## 为什么要开发这个模板 +### 为什么要开发这个模板 -1. Vue3 和 Vite 已经趋于成熟，学习 vite 和 vue3 非常有必要，通过开发模板进行学习是一个很好的方式，事实也证明我确实从中获益良多 -2. 目前主流的 Vue3+Vite 后台管理模板都相对复杂，甚至感觉有点花里胡哨（没有贬低的意思，大部分的架构设计都很优秀，只是觉得集成了太多不实用的东西） -3. 自己搭的模板开发起来才最顺手。本人很反感拿别人的模板直接上手开发，如果非要拿别人的模板开发也会尽量先吃透再用，不吃透就没有代码的掌控感和安全感 +- Vue3 和 Vite 已经趋于成熟，学习 vite 和 vue3 非常有必要，通过开发模板进行学习是一个很好的方式，事实也证明我确实从中获益良多 +- 目前主流的 Vue3+Vite 后台管理模板都相对复杂，甚至感觉有点花里胡哨（没有贬低的意思，大部分的架构设计都很优秀，只是觉得集成了太多不实用的东西） -## 功能 +### 功能 -- 🍒 集成 Naive UI，尤大推荐的 UI 组件库，很香，https://www.naiveui.com -- 🍑 集成登陆、注销及权限验证（暂只支持角色页面权限，后续考虑添加按钮权限） +- 🍒 集成 Naive UI，尤大推荐的 UI 组件库，[https://www.naiveui.com](https://www.naiveui.com) +- 🍑 集成登陆、注销及权限验证 - 🍐 集成多环境配置，dev、测试、预发布和生产 -- 🍎 集成 eslint + prettier，代码约束和格式化统一 +- 🍎 集成 Eslint + Prettier，代码约束和格式化统一 - 🍉 集成 Mock 接口服务，dev 环境和发布环境都支持，可动态配置是否启用 mock 服务，不启用时不会加载 mock 包，减少打包体积 -- 🍇 集成 unocss，antfu 大神开源的原子化 css 解决方案，非常轻量，目前我是自己写 scss 样式搭配着 unocss 使用的，很香 -- 🍍 集成 pinia，Vuex 的替代方案，轻量、简单、易用，很香 -- 🍏 集成 axios，支持多 axios 实例，支持线上环境免重新打包修改 baseURL +- 🍇 集成 unocss，antfu 大神开源的原子化 css 解决方案，非常轻量，目前我是自己写 scss 样式搭配着 unocss 使用的 +- 🍍 集成 Pinia，Vuex 的替代方案，轻量、简单、易用（尤大已表示不会有Vuex5，或者说pinia就是Vuex5） +- 📦 集成 Vite 自动导入插件unplugin-vue-components，解放双手，开发效率直接起飞 +- 🍏 二次封装 Axios，支持多 axios 实例，支持线上环境免重新打包修改 baseURL - 🍌 二次封装全局 Dialog、Message、LoadingBar 组件 - 🍋 二次封装 localStorage 和 sessionStorage，支持设置过期时间 @@ -29,6 +29,7 @@ Vue Naive Admin，一个基于 Vue3.0、Vite、Naive UI 的轻量级后台管理 ## 文档 +[Vue Naive Admin Docs](https://zclzone.github.io/vue-naive-admin-docs) [羽雀文档：Vue Naive Admin](https://www.yuque.com/qszone/vue-naive-admin) ## 构建步骤