|
|
@@ -1,184 +0,0 @@
|
|
1
|
|
-# Geeker-Admin
|
|
2
|
|
-
|
|
3
|
|
-### 介绍 📖
|
|
4
|
|
-
|
|
5
|
|
-Geeker-Admin 一款基于 Vue3.3、TypeScript、Vite5、Pinia、Element-Plus 开源的后台管理框架,使用目前最新技术栈开发。项目提供强大的 [ProTable](https://juejin.cn/post/7166068828202336263) 组件,在一定程度上提高您的开发效率。另外本项目还封装了一些常用组件、Hooks、指令、动态路由、按钮级别权限控制等功能。
|
|
6
|
|
-
|
|
7
|
|
-### React 版本 🔥
|
|
8
|
|
-
|
|
9
|
|
-- 有需要请加底部微信了解、购买
|
|
10
|
|
-
|
|
11
|
|
-- Link:https://pro.spicyboy.cn
|
|
12
|
|
-
|
|
13
|
|
-### 在线预览 👀
|
|
14
|
|
-
|
|
15
|
|
-- Link:https://admin.spicyboy.cn
|
|
16
|
|
-
|
|
17
|
|
-### 代码仓库 ⭐
|
|
18
|
|
-
|
|
19
|
|
-- Gitee:https://gitee.com/HalseySpicy/Geeker-Admin
|
|
20
|
|
-- GitHub:https://github.com/HalseySpicy/Geeker-Admin
|
|
21
|
|
-
|
|
22
|
|
-### 项目文档 📚
|
|
23
|
|
-
|
|
24
|
|
-- 项目更新日志:[CHANGELOG.md](./CHANGELOG.md)
|
|
25
|
|
-
|
|
26
|
|
-- 项目文档地址:https://docs.spicyboy.cn
|
|
27
|
|
-
|
|
28
|
|
-### 项目功能 🔨
|
|
29
|
|
-
|
|
30
|
|
-- 使用 Vue3.3 + TypeScript 开发,单文件组件**<script setup>**
|
|
31
|
|
-- 采用 Vite5 作为项目开发、打包工具(配置 gzip/brotli 打包、tsx 语法、跨域代理…)
|
|
32
|
|
-- 使用 Pinia 替代 Vuex,轻量、简单、易用,集成 Pinia 持久化插件
|
|
33
|
|
-- 使用 TypeScript 对 Axios 整个二次封装(请求拦截、取消、常用请求封装…)
|
|
34
|
|
-- 基于 Element 二次封装 [ProTable](https://juejin.cn/post/7166068828202336263) 组件,表格页面全部为配置项 Columns
|
|
35
|
|
-- 支持 Element 组件大小切换、多主题布局、暗黑模式、i18n 国际化
|
|
36
|
|
-- 使用 VueRouter 配置动态路由权限拦截、路由懒加载,支持页面按钮权限控制
|
|
37
|
|
-- 使用 KeepAlive 对页面进行缓存,支持多级嵌套路由缓存
|
|
38
|
|
-- 常用自定义指令开发(权限、复制、水印、拖拽、节流、防抖、长按…)
|
|
39
|
|
-- 使用 Prettier 统一格式化代码,集成 ESLint、Stylelint 代码校验规范
|
|
40
|
|
-- 使用 husky、lint-staged、commitlint、czg、cz-git 规范提交信息
|
|
41
|
|
-
|
|
42
|
|
-### 安装使用步骤 📔
|
|
43
|
|
-
|
|
44
|
|
-- **Clone:**
|
|
45
|
|
-
|
|
46
|
|
-```text
|
|
47
|
|
-# Gitee
|
|
48
|
|
-git clone https://gitee.com/HalseySpicy/Geeker-Admin.git
|
|
49
|
|
-# GitHub
|
|
50
|
|
-git clone https://github.com/HalseySpicy/Geeker-Admin.git
|
|
51
|
|
-```
|
|
52
|
|
-
|
|
53
|
|
-- **Install:**
|
|
54
|
|
-
|
|
55
|
|
-```text
|
|
56
|
|
-pnpm install
|
|
57
|
|
-```
|
|
58
|
|
-
|
|
59
|
|
-- **Run:**
|
|
60
|
|
-
|
|
61
|
|
-```text
|
|
62
|
|
-pnpm dev
|
|
63
|
|
-pnpm serve
|
|
64
|
|
-```
|
|
65
|
|
-
|
|
66
|
|
-- **Build:**
|
|
67
|
|
-
|
|
68
|
|
-```text
|
|
69
|
|
-# 开发环境
|
|
70
|
|
-pnpm build:dev
|
|
71
|
|
-
|
|
72
|
|
-# 测试环境
|
|
73
|
|
-pnpm build:test
|
|
74
|
|
-
|
|
75
|
|
-# 生产环境
|
|
76
|
|
-pnpm build:pro
|
|
77
|
|
-```
|
|
78
|
|
-
|
|
79
|
|
-- **Lint:**
|
|
80
|
|
-
|
|
81
|
|
-```text
|
|
82
|
|
-# eslint 检测代码
|
|
83
|
|
-pnpm lint:eslint
|
|
84
|
|
-
|
|
85
|
|
-# prettier 格式化代码
|
|
86
|
|
-pnpm lint:prettier
|
|
87
|
|
-
|
|
88
|
|
-# stylelint 格式化样式
|
|
89
|
|
-pnpm lint:stylelint
|
|
90
|
|
-```
|
|
91
|
|
-
|
|
92
|
|
-- **commit:**
|
|
93
|
|
-
|
|
94
|
|
-```text
|
|
95
|
|
-# 提交代码(提交前会自动执行 lint:lint-staged 命令)
|
|
96
|
|
-pnpm commit
|
|
97
|
|
-```
|
|
98
|
|
-
|
|
99
|
|
-### 项目截图 📷
|
|
100
|
|
-
|
|
101
|
|
-- 登录页:
|
|
102
|
|
-
|
|
103
|
|
-
|
|
104
|
|
-
|
|
105
|
|
-
|
|
106
|
|
-
|
|
107
|
|
-- 首页:
|
|
108
|
|
-
|
|
109
|
|
-
|
|
110
|
|
-
|
|
111
|
|
-
|
|
112
|
|
-
|
|
113
|
|
-- 表格页:
|
|
114
|
|
-
|
|
115
|
|
-
|
|
116
|
|
-
|
|
117
|
|
-
|
|
118
|
|
-
|
|
119
|
|
-- 数据可视化
|
|
120
|
|
-
|
|
121
|
|
-
|
|
122
|
|
-
|
|
123
|
|
-- 数据大屏:
|
|
124
|
|
-
|
|
125
|
|
-
|
|
126
|
|
-
|
|
127
|
|
-### 文件资源目录 📚
|
|
128
|
|
-
|
|
129
|
|
-```text
|
|
130
|
|
-Geeker-Admin
|
|
131
|
|
-├─ .husky # husky 配置文件
|
|
132
|
|
-├─ .vscode # VSCode 推荐配置
|
|
133
|
|
-├─ build # Vite 配置项
|
|
134
|
|
-├─ public # 静态资源文件(该文件夹不会被打包)
|
|
135
|
|
-├─ src
|
|
136
|
|
-│ ├─ api # API 接口管理
|
|
137
|
|
-│ ├─ assets # 静态资源文件
|
|
138
|
|
-│ ├─ components # 全局组件
|
|
139
|
|
-│ ├─ config # 全局配置项
|
|
140
|
|
-│ ├─ directives # 全局指令文件
|
|
141
|
|
-│ ├─ enums # 项目常用枚举
|
|
142
|
|
-│ ├─ hooks # 常用 Hooks 封装
|
|
143
|
|
-│ ├─ languages # 语言国际化 i18n
|
|
144
|
|
-│ ├─ layouts # 框架布局模块
|
|
145
|
|
-│ ├─ routers # 路由管理
|
|
146
|
|
-│ ├─ stores # pinia store
|
|
147
|
|
-│ ├─ styles # 全局样式文件
|
|
148
|
|
-│ ├─ typings # 全局 ts 声明
|
|
149
|
|
-│ ├─ utils # 常用工具库
|
|
150
|
|
-│ ├─ views # 项目所有页面
|
|
151
|
|
-│ ├─ App.vue # 项目主组件
|
|
152
|
|
-│ ├─ main.ts # 项目入口文件
|
|
153
|
|
-│ └─ vite-env.d.ts # 指定 ts 识别 vue
|
|
154
|
|
-├─ .editorconfig # 统一不同编辑器的编码风格
|
|
155
|
|
-├─ .env # vite 常用配置
|
|
156
|
|
-├─ .env.development # 开发环境配置
|
|
157
|
|
-├─ .env.production # 生产环境配置
|
|
158
|
|
-├─ .env.test # 测试环境配置
|
|
159
|
|
-├─ .eslintignore # 忽略 Eslint 校验
|
|
160
|
|
-├─ .eslintrc.cjs # Eslint 校验配置文件
|
|
161
|
|
-├─ .gitignore # 忽略 git 提交
|
|
162
|
|
-├─ .prettierignore # 忽略 Prettier 格式化
|
|
163
|
|
-├─ .prettierrc.cjs # Prettier 格式化配置
|
|
164
|
|
-├─ .stylelintignore # 忽略 stylelint 格式化
|
|
165
|
|
-├─ .stylelintrc.cjs # stylelint 样式格式化配置
|
|
166
|
|
-├─ CHANGELOG.md # 项目更新日志
|
|
167
|
|
-├─ commitlint.config.cjs # git 提交规范配置
|
|
168
|
|
-├─ index.html # 入口 html
|
|
169
|
|
-├─ LICENSE # 开源协议文件
|
|
170
|
|
-├─ lint-staged.config.cjs # lint-staged 配置文件
|
|
171
|
|
-├─ package-lock.json # 依赖包包版本锁
|
|
172
|
|
-├─ package.json # 依赖包管理
|
|
173
|
|
-├─ postcss.config.cjs # postcss 配置
|
|
174
|
|
-├─ README.md # README 介绍
|
|
175
|
|
-├─ tsconfig.json # typescript 全局配置
|
|
176
|
|
-└─ vite.config.ts # vite 全局配置文件
|
|
177
|
|
-```
|
|
178
|
|
-
|
|
179
|
|
-### 项目后台接口 🧩
|
|
180
|
|
-
|
|
181
|
|
-项目后台接口完全采用 Mock 数据,感谢以下 Mock 平台支持:
|
|
182
|
|
-
|
|
183
|
|
-- FastMock: https://www.fastmock.site
|
|
184
|
|
-- EasyMock:https://mock.mengxuegu.com
|