Updated doc

pull/559/head
cbkim 2019-08-02 10:42:39 +03:00 committed by GitHub
parent 1d517316ea
commit f6fa81c6af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 42 deletions

View File

@ -1,4 +1,4 @@
<h1 style="text-align: center">el-admin 后台管理系统</h1> <h1 style="text-align: center">el-admin Backend</h1>
<div style="text-align: center"> <div style="text-align: center">
[![AUR](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://github.com/elunez/eladmin/blob/master/LICENSE) [![AUR](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://github.com/elunez/eladmin/blob/master/LICENSE)
@ -8,56 +8,55 @@
</div> </div>
#### 项目简介 #### Project description
eladmin基于 Spring Boot 2.1.0 、 Jpa、 Spring Security、redis、Vue的前后端分离的后台管理系统 权限控制的方式为RBAC项目支持数据字典与数据权限管理支持一键生成前后端代码支持前端菜单动态路由 eladmin-en Using , Spring Boot 2.1.0 、 Jpa、 Spring Security、redis、Vue back-end management system Permissions using RBACThe project supports data dictionary and data permission management, supports one-click generation of front-end and end-end code, and supports front-end menu dynamic routing.
**开发文档** [https://docs.auauz.net/](https://docs.auauz.net) **Development Documentation** [https://docs.auauz.net/](https://docs.auauz.net)
**体验地址** [https://auauz.net/](https://auauz.net/) **Demo** [https://auauz.net/](https://auauz.net/)
**账号密码** ```admin/123456```(默认密码都是123456) **login details** ```admin/123456```(default password 123456)
#### 项目源码 #### Project source code
| | 后端源码 | 前端源码 | | | Backend source | Front end source |
|--- |--- | --- | |--- |--- | --- |
| github | https://github.com/elunez/eladmin | https://github.com/elunez/eladmin-qd | | github | https://github.com/elunez/eladmin | https://github.com/elunez/eladmin-qd |
| 码云 | https://gitee.com/elunez/eladmin | https://gitee.com/elunez/eladmin-qt | | Cloud code | https://gitee.com/elunez/eladmin | https://gitee.com/elunez/eladmin-qt |
#### 系统功能 #### System functions
- 用户管理提供用户的相关配置新增用户后默认密码为123456 - User Management: Provides the user's related configuration. After adding a new user, the default password is 123456.
- 角色管理:对权限与菜单进行分配,可根据部门设置角色的数据权限 - Role management: Assign permissions and menus, set data permissions for roles based on department
- 权限管理:权限细化到接口,可以理解成按钮权限 - Rights management: permissions are refined to interfaces, which can be understood as button permissions
- 菜单管理:已实现菜单动态路由,后端可配置化,支持多级菜单 - Menu management: Dynamic menu routing has been implemented, backend configurable, multi-level menu support
- 部门管理:可配置系统组织架构,树形表格展示 - Department management: configurable system organization structure, tree table display
- 岗位管理:配置各个部门的职位 - Position management: Configuring positions in various departments
- 字典管理:应广大码友的要求加入字典管理,可维护常用一些固定的数据,如:状态,性别等 - Dictionary management: It should be added to the dictionary management at the request of the majority of code friends, and can maintain some fixed data commonly used, such as: status, gender, etc.
- 操作日志:记录用户操作的日志 - Operation log: log of user operations
- 异常日志:记录异常日志,方便开发人员定位错误 - Exception log: record exception logs for developers to locate errors
- 系统缓存使用jedis将缓存操作可视化并提供对redis的基本操作可根据需求自行扩展 - System Cache: Visualize caching operations with jedis and provide basic operations on redis, which can be extended as needed
- SQL监控采用druid 监控数据库访问性能默认用户名admin密码123456 - SQL monitoring: use druid to monitor database access performance, default username admin, password 123456
- 定时任务整合Quartz做定时任务加入任务日志任务运行情况一目了然 - Timed tasks: Integrate Quartz to do scheduled tasks, join the task log, and see the task running at a glance
- 代码生成高灵活度一键生成前后端代码减少百分之80左右的工作任务 - Code generation: High flexibility, one-click generation of front and rear code, reducing work tasks by 80% or so
- 邮件工具配合富文本发送html格式的邮件 - Mail tool: send text in html format with rich text
- 免费图床使用sm.ms图床用作公共图片上传使用 - Free map bed: use sm.ms map bed for public image upload
- 七牛云存储:可同步七牛云存储的数据到系统,无需登录七牛云直接操作云数据 - Seven cattle cloud storage: can synchronize the data stored in the seven cattle cloud to the system, without having to log in to the seven cattle cloud to directly operate the cloud data
- 支付宝支付:整合了支付宝支付并且提供了测试账号,可自行测试 - Alipay payment: integrated Alipay payment and provided test account, you can test it yourself
#### 项目结构
项目采用分模块开发方式,将通用的配置放在公共模块,```system```模块为系统核心模块也是项目入口模块,```logging``` 模块为系统的日志模块,```tools``` 为第三方工具模块,包含了图床、邮件、七牛云、支付宝,```generator``` 为系统的代码生成模块
- eladmin-common 公共模块
- exception 项目统一异常的处理
- mapper mapstruct的通用mapper
- redis redis缓存相关配置
- swagger2 接口文档配置
- utils 系统通用工具类
- eladmin-system 系统核心模块(系统启动入口)
- config 配置跨域与静态资源,与数据权限
- modules 系统相关模块(登录授权、定时任务等)
- eladmin-logging 系统日志模块
- eladmin-tools 系统第三方工具模块
- eladmin-generator 系统代码生成模块
#### Project structure
The project adopts the sub-module development method, and the general configuration is placed in the common module. The ```system`` module is the system core module and the project entry module. The ```logging``` module is the system log module, ``` Tools``` is a third-party tool module that contains the map bed, mail, seven cattle cloud, Alipay, ```generator``` for the system code generation module
- eladmin-common public module
     - exception handling of uniform exceptions
     - generic mapper for mapper mapstruct
     - redis redis cache related configuration
     - swagger2 interface document configuration
     - utils system generic tool class
- eladmin-system system core module (system boot entry)
- config configure cross-domain and static resources, with data permissions
- modules system related modules (login authorization, scheduled tasks, etc.)
- eladmin-logging system log module
- eladmin-tools system third-party tool module
- eladmin-generator system code generation module
#### 系统预览 #### 系统预览
<table> <table>
<tr> <tr>