Skip to content

Commit c8b195d

Browse files
committed
docs: 更新 README
1 parent 416f60f commit c8b195d

File tree

2 files changed

+46
-2
lines changed

2 files changed

+46
-2
lines changed

README.md

+27-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,36 @@
11
## ⚡️ 简介
22

3-
一个中后台管理系统基础解决方案,基于 Vue3、TypeScript、Element-Plus、Pinia 和 Vite.
3+
一个免费开源的中后台管理系统基础解决方案,基于 Vue3、TypeScript、Element-Plus、Pinia 和 Vite 等主流技术.
44

5-
模板代码是从 [v3-admin v3.1.3](https://github.com/un-pany/v3-admin) 迁移而来,只是脚手架从 vue-cli 5.x 切换到了 vite,并作了一些繁琐的适配.
5+
模板代码是从 [v3-admin](https://github.com/un-pany/v3-admin) 迁移而来,脚手架从 vue-cli 5.x 切换到了 vite 2.9.x,并作了一些繁琐的适配.
66

77
更推荐大家使用该 vite 版本!以后的重心也会从 [v3-admin](https://github.com/un-pany/v3-admin) 偏向本仓库.
88

9+
## 特性
10+
11+
- **Vue3**:采用 Vue3 + script setup 最新的 Vue3 组合式 API
12+
- **Element Plus**:Element UI 的正统续作
13+
- **Pinia**: 传说中的 Vuex5
14+
- **Vite**:真的很快
15+
- **Vue Router**:没啥好说的
16+
- **TypeScript**:JavaScript 语言的超集
17+
- **PNPM**:更快速的,节省磁盘空间的包管理工具
18+
- **Sass**:和 Element Plus 保持一致
19+
- **Eslint**:代码校验
20+
- **Pritter**:代码格式化
21+
- **Axios**:没啥好说的,已封装好
22+
- **注释**:各个配置项都写有尽可能详细的注释
23+
24+
## 功能
25+
26+
- **用户管理**:登录、登出演示
27+
- **权限管理**:内置页面权限(动态路由)、指令权限、权限函数、路由守卫
28+
- **多环境**:开发环境(development)、预发布环境(staging)、正式环境(production)
29+
- **多主题**:内置普通、黑暗两种主题模式
30+
- **错误页面**: 401、404
31+
- **Dashboard**:根据不同用户显示不同的 Dashboard 页面
32+
- **其他内置功能**:SVG、动态侧边栏、动态面包屑、标签页快捷导航、Screenfull 全屏、自适应收缩侧边栏(兼容移动端)
33+
934
## 📚 文档
1035

1136
[简体中文](https://juejin.cn/post/7089377403717287972)

types/components.d.ts

+19
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,25 @@ import '@vue/runtime-core'
55

66
declare module '@vue/runtime-core' {
77
export interface GlobalComponents {
8+
ElAvatar: typeof import('element-plus/es')['ElAvatar']
9+
ElBreadcrumb: typeof import('element-plus/es')['ElBreadcrumb']
10+
ElBreadcrumbItem: typeof import('element-plus/es')['ElBreadcrumbItem']
11+
ElDrawer: typeof import('element-plus/es')['ElDrawer']
12+
ElDropdown: typeof import('element-plus/es')['ElDropdown']
13+
ElDropdownItem: typeof import('element-plus/es')['ElDropdownItem']
14+
ElDropdownMenu: typeof import('element-plus/es')['ElDropdownMenu']
15+
ElIcon: typeof import('element-plus/es')['ElIcon']
16+
ElMenu: typeof import('element-plus/es')['ElMenu']
17+
ElMenuItem: typeof import('element-plus/es')['ElMenuItem']
18+
ElRadioButton: typeof import('element-plus/es')['ElRadioButton']
19+
ElRadioGroup: typeof import('element-plus/es')['ElRadioGroup']
20+
ElScrollbar: typeof import('element-plus/es')['ElScrollbar']
21+
ElSubMenu: typeof import('element-plus/es')['ElSubMenu']
22+
ElSwitch: typeof import('element-plus/es')['ElSwitch']
23+
ElTabPane: typeof import('element-plus/es')['ElTabPane']
24+
ElTabs: typeof import('element-plus/es')['ElTabs']
25+
ElTag: typeof import('element-plus/es')['ElTag']
26+
ElTooltip: typeof import('element-plus/es')['ElTooltip']
827
RouterLink: typeof import('vue-router')['RouterLink']
928
RouterView: typeof import('vue-router')['RouterView']
1029
Screenfull: typeof import('./../src/components/Screenfull/index.vue')['default']

0 commit comments

Comments
 (0)