Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
suyuan32 committed Feb 6, 2023
1 parent 5345bee commit ef13944
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 73 deletions.
58 changes: 25 additions & 33 deletions README.En.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,47 +19,39 @@ Simple Admin UI is a modern UI for Simple Admin. It is based on vue-vben-admin a
- **Authority** Built-in complete dynamic routing permission generation scheme.
- **Component** Multiple commonly used components are encapsulated twice

## Current Progress

- [x] Login and Register
- [x] Menu Management
- [x] Role Management
- [x] Role Authority
- [x] User Management
- [x] Operation log
- [x] Service discovery
- [x] Dictionary management
- [x] Oauth management
- [x] Fully support K8s
- [x] Service Monitor
- [x] Log collecting
- [x] JWT blacklist
- [x] Job Schedule
- [x] Message queue
- [x] Ent
- [x] Backend CRUD generation
- [x] Frontend CRUD code generation
- [ ] docker-compose script
## Support functions

- User management: The user is the system operator, and this function mainly completes the system user configuration.
- Department management: Configure the system organization (company, department, group), and the tree structure shows the support data permissions.
- Position management: configure the positions that system users belong to.
- Menu management: configure system menu, operation authority, button authority identification, interface authority, etc.
- Role management: role menu permission assignment, role setting, data range permission division by organization.
- Dictionary management: maintain some relatively fixed data frequently used in the system.
- Operation log: system normal operation log record and query; system abnormal information log record and query.
- Member management: manage registered member information
- Interface documents: Automatically generate relevant API interface documents based on business codes.
- Code generation: Generate corresponding additions, deletions, modifications, and queries based on the data table structure
- Service monitoring: View some basic information about servers

## Project Planning Progress

[RoadMap](https://github.com/suyuan32/simple-admin-core/issues/63)

### Online preview
[Online Preview](http://101.132.124.135/#/dashboard)
Account: admin
Password: simple-admin

[Online Preview](http://101.132.124.135/#/dashboard) Account: admin Password: simple-admin

#### Read Only, cannot register and modify

![pic](https://i.postimg.cc/qqPNR02x/register-zh-cn.png)
![pic](https://i.postimg.cc/PxczkCr6/dashboard-zh-cn.png)
![pic](https://i.postimg.cc/qqPNR02x/register-zh-cn.png) ![pic](https://i.postimg.cc/PxczkCr6/dashboard-zh-cn.png)

[More](https://suyuan32.github.io/simple-admin-core/#/simple-admin/zh-cn/docs/screenshot)


## Documentation

[Simple Admin Documentation](https://suyuan32.github.io/simple-admin-core/)

- vben admin document
[Document](https://vvbin.cn/doc-next/)
- vben admin document [Document](https://vvbin.cn/doc-next/)
- ant-design-vue [Document](https://antdv.com/components/overview)

## Preparation
Expand Down Expand Up @@ -88,9 +80,9 @@ cd Simple-Admin-ui

pnpm install

# or
# or

npm install
npm install

# or

Expand All @@ -107,7 +99,7 @@ pnpm serve

npm serve

# or
# or

yarn serve
```
Expand All @@ -117,7 +109,7 @@ yarn serve
```bash
pnpm build

# or
# or

npm build

Expand Down
60 changes: 25 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## 简介

Simple Admin UI 是基于vue-vben-admin二次开发的为Simple Admin专门开发的后台管理界面,基于Vue3和TypeScript开发, 提供后台错误统一处理,国际化等功能,本项目完全免费,可用于学习和商用
Simple Admin UI 是基于 vue-vben-admin 二次开发的为 Simple Admin 专门开发的后台管理界面,基于 Vue3 和 TypeScript 开发, 提供后台错误统一处理,国际化等功能,本项目完全免费,可用于学习和商用

## 特性

Expand All @@ -19,45 +19,35 @@ Simple Admin UI 是基于vue-vben-admin二次开发的为Simple Admin专门开
- **权限** 内置完善的动态路由权限生成方案
- **组件** 二次封装了多个常用的组件

## 当前进度


- [x] 登录注册
- [x] 菜单管理
- [x] 角色管理
- [x] 角色权限
- [x] 用户管理
- [x] 操作日志
- [x] 服务注册发现
- [x] 字典功能
- [x] 三方登录管理
- [x] 全面支持 K8s
- [x] 服务监控
- [x] 日志收集
- [x] JWT黑名单
- [x] 定时任务
- [x] 消息队列
- [x] Ent
- [x] 后端 CRUD 代码生成
- [x] 前端 CRUD 代码生成
- [ ] 一键运行 demo 脚本
## 支持功能

- 用户管理:用户是系统操作者,该功能主要完成系统用户配置。
- 部门管理:配置系统组织机构(公司、部门、小组),树结构展现支持数据权限。
- 岗位管理:配置系统用户所属担任职务。
- 菜单管理:配置系统菜单,操作权限,按钮权限标识,接口权限等。
- 角色管理:角色菜单权限分配、设置角色按机构进行数据范围权限划分。
- 字典管理:对系统中经常使用的一些较为固定的数据进行维护。
- 操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。
- 会员管理:管理注册会员信息
- 接口文档:根据业务代码自动生成相关的 api 接口文档。
- 代码生成:根据数据表结构生成对应的增删改查相对应业务
- 服务监控:查看一些服务器的基本信息

## 项目规划进度

[RoadMap](https://github.com/suyuan32/simple-admin-core/issues/63)

## 预览

### 在线预览
[在线预览](http://101.132.124.135/#/dashboard)
账号 admin
密码 simple-admin
#### 只读,不可修改和注册

![pic](https://i.postimg.cc/qqPNR02x/register-zh-cn.png)
![pic](https://i.postimg.cc/PxczkCr6/dashboard-zh-cn.png)

[更多预览](https://suyuan32.github.io/simple-admin-core/#/simple-admin/zh-cn/docs/screenshot)
[在线预览](http://101.132.124.135/#/dashboard) 账号 admin 密码 simple-admin

#### 只读,不可修改和注册

![pic](https://i.postimg.cc/qqPNR02x/register-zh-cn.png) ![pic](https://i.postimg.cc/PxczkCr6/dashboard-zh-cn.png)

[更多预览](https://suyuan32.github.io/simple-admin-core/#/simple-admin/zh-cn/docs/screenshot)

## 文档

Expand Down Expand Up @@ -92,9 +82,9 @@ cd Simple-Admin-ui

pnpm install

# or
# or

npm install
npm install

# or

Expand All @@ -111,7 +101,7 @@ pnpm serve

npm serve

# or
# or

yarn serve
```
Expand All @@ -121,7 +111,7 @@ yarn serve
```bash
pnpm build

# or
# or

npm build

Expand Down
10 changes: 5 additions & 5 deletions src/views/sys/token/token.data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ export const columns: BasicColumn[] = [
{
title: 'UUID',
dataIndex: 'UUID',
width: 200,
width: 100,
},
{
title: 'Token',
dataIndex: 'token',
width: 200,
width: 100,
},
{
title: t('common.source'),
Expand All @@ -28,7 +28,7 @@ export const columns: BasicColumn[] = [
{
title: t('common.statusName'),
dataIndex: 'status',
width: 120,
width: 50,
customRender: ({ record }) => {
if (!Reflect.has(record, 'pendingStatus')) {
record.pendingStatus = false;
Expand Down Expand Up @@ -60,15 +60,15 @@ export const columns: BasicColumn[] = [
{
title: t('common.createTime'),
dataIndex: 'createdAt',
width: 70,
width: 50,
customRender: ({ record }) => {
return formatToDateTime(record.createdAt);
},
},
{
title: t('common.expiredAt'),
dataIndex: 'expiredAt',
width: 70,
width: 50,
customRender: ({ record }) => {
return formatToDateTime(record.expiredAt);
},
Expand Down

0 comments on commit ef13944

Please sign in to comment.