Skip to content

Commit

Permalink
update readme && api path
Browse files Browse the repository at this point in the history
  • Loading branch information
penndev committed Sep 12, 2024
1 parent 4b55cd6 commit f1c4f18
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .env.development
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
VE_NAME=VEAdmin
VE_API_URL=//127.0.0.1:8000/api
VE_API_URL=//127.0.0.1:8000/admin
2 changes: 1 addition & 1 deletion .env.production
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
VE_NAME=VEAdmin
VE_API_URL=https://497e1279-a6db-429e-ba52-be9a5415e6d2.mock.pstmn.io/api
VE_API_URL=https://497e1279-a6db-429e-ba52-be9a5415e6d2.mock.pstmn.io/admin
38 changes: 23 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,29 @@ GitHub Pages 预览 [https://penndev.github.io/veadmin](https://penndev.github.i

## 快速上手

> 使用`vue3``element-plus`作为基础框架,`vite`做打包工具,`pinia`做数据持久化,`axios`做api交互,`echarts`做图标数据展现。
- **用户登录**
- 用户验证码
1. 图片验证码使用base64方式返回图片验证码。
2. 验证码验证存活时间(TTL)。
3. 每次图片验证后不论结果都需要刷新验证码,接口方需要同步操作避免碰撞攻击。
- [登录接口](https://github.com/penndev/veadmin/blob/main/src/views/login.vue#L161)
- [登录信息](https://github.com/penndev/veadmin/blob/main/src/stores/module/auth.js#L5)
1. token 为后台接口的jwt验证参数。
2. routes 改用户可以访问的前端路由(在后面介绍)
- [JWT接口鉴权](https://github.com/penndev/veadmin/blob/main/src/utils/request.js#L21)
- **页面路由:**[`此文件`](https://github.com/penndev/veadmin/blob/main/src/router/index.js#L56)中实现。添加页面路由可参考`example`的实现。移除不需要的页面路由可删除`routes`中的路由配置,和对应大目标页面vue文件。
- **菜单鉴权:**[`此位置`](https://github.com/penndev/veadmin/blob/main/src/router/auth.js#L30) 验证菜单权限(直接`auth.routes === '*'`则全放行),菜单全部静态装载,根据权限判断是否放行。
- **后端权限:** [`API鉴权`](https://github.com/penndev/veadmin/blob/main/src/utils/request.js#L20) 根据token进行交付后端权限验证。
> 使用`vue3``element-plus`作为基础框架,`vite`做打包工具,`pinia`做数据持久化,`axios`做api交互,`echarts`做图表数据展现。
#### 用户登录

- **验证码**
1. 图片验证码使用base64方式返回图片验证码。
2. 验证码验证存活时间(TTL)。
3. 每次图片验证后不论结果都需要刷新验证码,接口方需要同步操作避免碰撞攻击。
- [**登录请求**](https://github.com/penndev/veadmin/blob/main/src/views/login.vue#L161)
- 登录接口携带账号密码与验证码
- 验证码必要性,碰撞攻击在中小型后台的危害特别大。需要严格注意方法措施(验证码,弱密码,登录入口等)
- [**登录返回参数**](https://github.com/penndev/veadmin/blob/main/src/stores/module/auth.js#L5)
1. token 为后台接口的jwt验证参数。
2. routes 当前登录用户可以访问的前端路由(在后面介绍)
- **接口验证**
> 真正的数据安全应该为后台来处理,前端只能控制页面的展现,不能通过前端数据展示控制来保证数据安全。
- [**JWT后端交互验证**](https://github.com/penndev/veadmin/blob/main/src/utils/request.js#L20)
- [**数据展示权限验证**](https://github.com/penndev/veadmin/blob/main/src/router/auth.js#L13)

#### 请求接口

....


如有疑问或建议欢迎随时与我互相[交流](mailto:pennilessfor@gmail.com?subject=veadmin)学习。

Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/logo.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" />
<title>Admin Panel</title>
<title>VEAdmin Panel</title>
</head>
<body>
<div id="app"></div>
Expand Down
3 changes: 1 addition & 2 deletions src/styles/index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
// 夜间模式
@import 'element-plus/theme-chalk/dark/css-vars.css';


:root {
--ea-main-color: #ffffff;
--ea-aside-color: #191a23;
Expand Down Expand Up @@ -82,7 +81,7 @@

}

// 对小屏幕做优化
// 对小屏幕优化
@media screen and (max-width: 768px) {

.el-main {
Expand Down

0 comments on commit f1c4f18

Please sign in to comment.