Template
1
0
mirror of https://github.com/un-pany/v3-admin-vite.git synced 2025-04-20 10:59:21 +08:00

docs: update the README

This commit is contained in:
pany 2023-08-10 18:22:32 +08:00
parent ac1b621667
commit 9f486757b8
2 changed files with 22 additions and 6 deletions

View File

@ -6,11 +6,19 @@
## ⚡ Introduction
v3-admin-vite is a free and open source middle and background management system basic solution, based on mainstream framework such as Vue3, TypeScript, Element Plus, Pinia and Vite.
v3-admin-vite is a free and open source middle and background management system basic solution, based on mainstream framework such as Vue3, TypeScript, Element Plus, Pinia and Vite
- Vue-Cli 5.x: [v3-admin](https://github.com/un-pany/v3-admin)
- Electron desktop: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
## ❤️ Generate electricity with love
- **Completely free**But hopefully you order a star !!!
- **Very concise**No complicated encapsulation, no complicated type gymnastics, out of the box
- **Detailed annotations**Each configuration item is written with as detailed comments as possible
- **Latest dependencies**: Regularly update all third-party dependencies to the latest version
- **Very specification**: The code style is unified, the naming style is unified, and the comment style is unified
## Feature
- **Vue3**The latest Vue3 composition API using Vue3 + script setup
@ -26,7 +34,6 @@ v3-admin-vite is a free and open source middle and background management system
- **Prettier** Code formatting
- **Axios**: Promise based HTTP client (encapsulated)
- **UnoCSS**: Real-time atomized CSS engine with high performance and flexibility
- **Annotation**Each configuration item is written with as detailed comments as possible
- **Mobile Compatible**: The layout is compatible with mobile page resolution
## Functions
@ -35,9 +42,10 @@ v3-admin-vite is a free and open source middle and background management system
- **Authority management**: Built-in page permissions (dynamic routing), instruction permissions, permission functions
- **Multiple Environments**: Development, Staging, Production
- **Multiple themes**: Normal, Dark, Dark Blue, theme modes
- **Multiple layouts**Built-in left, top, left-top three layout modes
- **Error page**: 403, 404
- **Dashboard**: Display different Dashboard pages according to different users
- **Other functions**SVG, Dynamic Sidebar, Dynamic Breadcrumb Navigation, Tabbed Navigation, Screenfull, Adaptive Shrink Sidebar
- **Other functions**SVG, Dynamic Sidebar, Dynamic Breadcrumb Navigation, Tabbed Navigation, Screenfull, Adaptive Shrink Sidebar, HooK (Composables)
## 📚 Document

View File

@ -6,11 +6,19 @@
## ⚡ 简介
一个免费开源的中后台管理系统基础解决方案,基于 Vue3、TypeScript、Element Plus、Pinia 和 Vite 等主流技术.
一个免费开源的中后台管理系统基础解决方案,基于 Vue3、TypeScript、Element Plus、Pinia 和 Vite 等主流技术
- 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)
## ❤️ 用爱发电
- **完全免费**:但希望你点一个 star
- **非常简洁**:没有复杂的封装,没有复杂的类型体操,开箱即用
- **详细的注释**:各个配置项都写有尽可能详细的注释
- **最新的依赖**: 定期更新所有三方依赖至最新版
- **有一点规整**: 代码风格统一,命名风格统一,注释风格统一
## 特性
- **Vue3**:采用 Vue3 + script setup 最新的 Vue3 组合式 API
@ -26,7 +34,6 @@
- **Prettier**:代码格式化
- **Axios**:发送网络请求(已封装好)
- **UnoCSS**:具有高性能且极具灵活性的即时原子化 CSS 引擎
- **注释**:各个配置项都写有尽可能详细的注释
- **兼容移动端**: 布局兼容移动端页面分辨率
## 功能
@ -35,9 +42,10 @@
- **权限管理**:内置页面权限(动态路由)、指令权限、权限函数、路由守卫
- **多环境**开发环境development、预发布环境staging、正式环境production
- **多主题**:内置普通、黑暗、深蓝三种主题模式
- **多布局**:内置左侧、顶部、混合三种布局模式
- **错误页面**: 403、404
- **Dashboard**:根据不同用户显示不同的 Dashboard 页面
- **其他内置功能**SVG、动态侧边栏、动态面包屑、标签页快捷导航、Screenfull 全屏、自适应收缩侧边栏
- **其他内置功能**SVG、动态侧边栏、动态面包屑、标签页快捷导航、Screenfull 全屏、自适应收缩侧边栏、HookComposables
## 📚 文档