mirror of https://github.com/elunez/eladmin
update README.md
chanhengseang
parent
cb203819af
commit
605e396be9
184
README.md
184
README.md
|
|
@ -1,127 +1,123 @@
|
|||
<h1 style="text-align: center">ELADMIN 后台管理系统</h1>
|
||||
<div style="text-align: center">
|
||||
# ELADMIN Backend Management System
|
||||
|
||||
[](https://github.com/elunez/eladmin/blob/master/LICENSE)
|
||||
[](https://gitee.com/elunez/eladmin)
|
||||
[](https://github.com/elunez/eladmin)
|
||||
[](https://github.com/elunez/eladmin)
|
||||
|
||||
</div>
|
||||
## Project Introduction
|
||||
|
||||
#### 项目简介
|
||||
一个基于 Spring Boot 2.7.18 、 Spring Boot Jpa、 JWT、Spring Security、Redis、Vue的前后端分离的后台管理系统
|
||||
A front-end and back-end separated management system based on Spring Boot 2.7.18, Spring Boot JPA, JWT, Spring Security, Redis, and Vue.
|
||||
|
||||
现已发布基于 mybatis-plus 版本，项目地址：[https://github.com/elunez/eladmin-mp](https://github.com/elunez/eladmin-mp)、[https://gitee.com/elunez/eladmin-mp](https://gitee.com/elunez/eladmin-mp)。
|
||||
A MyBatis-Plus version has also been released:
|
||||
- [GitHub](https://github.com/elunez/eladmin-mp)
|
||||
- [Gitee](https://gitee.com/elunez/eladmin-mp)
|
||||
|
||||
**开发文档：** [https://eladmin.vip](https://eladmin.vip)
|
||||
**Documentation:** [https://eladmin.vip](https://eladmin.vip)
|
||||
|
||||
**体验地址：** [https://eladmin.vip/demo](https://eladmin.vip/demo)
|
||||
**Demo:** [https://eladmin.vip/demo](https://eladmin.vip/demo)
|
||||
|
||||
**账号密码：** `admin / 123456`
|
||||
**Demo Account:** `admin / 123456`
|
||||
|
||||
#### 项目源码
|
||||
## Source Code
|
||||
|
||||
| | 后端源码 | 前端源码 |
|
||||
|--- |--- | --- |
|
||||
| github | https://github.com/elunez/eladmin | https://github.com/elunez/eladmin-web |
|
||||
| 码云 | https://gitee.com/elunez/eladmin | https://gitee.com/elunez/eladmin-web |
|
||||
| | Backend Source | Frontend Source |
|
||||
|--------|---------------|----------------|
|
||||
| GitHub | https://github.com/elunez/eladmin | https://github.com/elunez/eladmin-web |
|
||||
| Gitee | https://gitee.com/elunez/eladmin | https://gitee.com/elunez/eladmin-web |
|
||||
|
||||
#### VPS推荐
|
||||
<a href="https://bwh81.net/aff.php?aff=70876" target="_blank">
|
||||
<img src="https://eladmin.vip/images/banner/side.jpeg" style="width: 435px;border-radius: 2px;">
|
||||
</a>
|
||||
## VPS Recommendation
|
||||
|
||||
使用优惠码: `BWHCGLUKKB`，可获得 6.81% 的折扣 [查看介绍](https://bwhstock.in/)
|
||||
[](https://bwh81.net/aff.php?aff=70876)
|
||||
|
||||
#### 主要特性
|
||||
- 使用最新技术栈，社区资源丰富。
|
||||
- 高效率开发，代码生成器可一键生成前后端代码
|
||||
- 支持数据字典，可方便地对一些状态进行管理
|
||||
- 支持接口限流，避免恶意请求导致服务层压力过大
|
||||
- 支持接口级别的功能权限与数据权限，可自定义操作
|
||||
- 自定义权限注解与匿名接口注解，可快速对接口拦截与放行
|
||||
- 对一些常用地前端组件封装：表格数据请求、数据字典等
|
||||
- 前后端统一异常拦截处理，统一输出异常，避免繁琐的判断
|
||||
- 支持在线用户管理与服务器性能监控，支持限制单用户登录
|
||||
- 支持运维管理，可方便地对远程服务器的应用进行部署与管理
|
||||
Use promo code: `BWHCGLUKKB` for a 6.81% discount [See details](https://bwhstock.in/)
|
||||
|
||||
#### 系统功能
|
||||
- 用户管理：提供用户的相关配置，新增用户后，默认密码为123456
|
||||
- 角色管理：对权限与菜单进行分配，可根据部门设置角色的数据权限
|
||||
- 菜单管理：已实现菜单动态路由，后端可配置化，支持多级菜单
|
||||
- 部门管理：可配置系统组织架构，树形表格展示
|
||||
- 岗位管理：配置各个部门的职位
|
||||
- 字典管理：可维护常用一些固定的数据，如：状态，性别等
|
||||
- 系统日志：记录用户操作日志与异常日志，方便开发人员定位排错
|
||||
- SQL监控：采用druid 监控数据库访问性能，默认用户名admin，密码123456
|
||||
- 定时任务：整合Quartz做定时任务，加入任务日志，任务运行情况一目了然
|
||||
- 代码生成：高灵活度生成前后端代码，减少大量重复的工作任务
|
||||
- 邮件工具：配合富文本，发送html格式的邮件
|
||||
- 七牛云存储：可同步七牛云存储的数据到系统，无需登录七牛云直接操作云数据
|
||||
- 支付宝支付：整合了支付宝支付并且提供了测试账号，可自行测试
|
||||
- 服务监控：监控服务器的负载情况
|
||||
- 运维管理：一键部署你的应用
|
||||
## Main Features
|
||||
|
||||
#### 项目结构
|
||||
项目采用按功能分模块的开发方式，结构如下
|
||||
- Uses the latest tech stack with rich community resources.
|
||||
- High development efficiency with code generator for one-click front-end and back-end code generation.
|
||||
- Supports data dictionaries for easy status management.
|
||||
- API rate limiting to prevent service overload from malicious requests.
|
||||
- Supports function-level and data-level permissions, with customizable operations.
|
||||
- Custom permission and anonymous API annotations for quick API interception and release.
|
||||
- Encapsulates common front-end components: table data requests, data dictionaries, etc.
|
||||
- Unified exception handling for both front and back ends, avoiding repetitive checks.
|
||||
- Online user management and server performance monitoring, with single-user login restriction.
|
||||
- Operations management for easy deployment and management of remote server applications.
|
||||
|
||||
- `eladmin-common` 为系统的公共模块，各种工具类，公共配置存在该模块
|
||||
## System Functions
|
||||
|
||||
- `eladmin-system` 为系统核心模块也是项目入口模块，也是最终需要打包部署的模块
|
||||
- User Management: Configure users; new users default to password `123456`.
|
||||
- Role Management: Assign permissions and menus, set data permissions by department.
|
||||
- Menu Management: Dynamic routing, back-end configurable, supports multi-level menus.
|
||||
- Department Management: Configure system organization structure, tree-shaped table display.
|
||||
- Position Management: Configure positions for each department.
|
||||
- Dictionary Management: Maintain common fixed data, such as status and gender.
|
||||
- System Log: Record user operation logs and exception logs for easy error tracking.
|
||||
- SQL Monitoring: Use Druid to monitor database access performance, default username `admin`, password `123456`.
|
||||
- Scheduled Tasks: Integrate Quartz for scheduled tasks, with task logs and task execution status.
|
||||
- Code Generation: High flexibility code generation for front-end and back-end, reducing repetitive work.
|
||||
- Email Tool: Send HTML format emails with rich text.
|
||||
- Qiniu Cloud Storage: Synchronize Qiniu cloud storage data to the system, no need to log in to Qiniu cloud to operate cloud data.
|
||||
- Alipay Payment: Integrate Alipay payment and provide a test account for self-testing.
|
||||
- Server Monitoring: Monitor server load status.
|
||||
- Operations Management: One-click deployment of your application.
|
||||
|
||||
- `eladmin-logging` 为系统的日志模块，其他模块如果需要记录日志需要引入该模块
|
||||
## Project Structure
|
||||
|
||||
- `eladmin-tools` 为第三方工具模块，包含：邮件、七牛云存储、本地存储、支付宝
|
||||
The project uses a modular development approach, with the following structure:
|
||||
|
||||
- `eladmin-generator` 为系统的代码生成模块，支持生成前后端CRUD代码
|
||||
- `eladmin-common`: System public module, including various utility classes and public configurations.
|
||||
- `eladmin-system`: System core module and project entry module, also the final module to be packaged and deployed.
|
||||
- `eladmin-logging`: System log module, other modules need to import this module to record logs.
|
||||
- `eladmin-tools`: Third-party tool module, including email, Qiniu cloud storage, local storage, and Alipay payment.
|
||||
- `eladmin-generator`: System code generation module, supporting front-end and back-end CRUD code generation.
|
||||
|
||||
#### 详细结构
|
||||
## Detailed Structure
|
||||
|
||||
```
|
||||
- eladmin-common 公共模块
|
||||
- annotation 为系统自定义注解
|
||||
- aspect 自定义注解的切面
|
||||
- base 提供了Entity、DTO基类和mapstruct的通用mapper
|
||||
- config 项目通用配置
|
||||
- Web配置跨域与静态资源映射、Swagger配置，文件上传临时路径配置
|
||||
- Redis配置，Redission配置, 异步线程池配置
|
||||
- 权限拦截配置、AuthorityConfig、Druid 删除广告配置
|
||||
- exception 项目统一异常的处理
|
||||
- utils 系统通用工具类，列举一些常用的工具类
|
||||
- BigDecimaUtils 金额计算工具类
|
||||
- RequestHolder 请求工具类
|
||||
- SecurityUtils 安全工具类
|
||||
- StringUtils 字符串工具类
|
||||
- SpringBeanHolder Spring Bean工具类
|
||||
- RedisUtils Redis工具类
|
||||
- EncryptUtils 加密工具类
|
||||
- FileUtil 文件工具类
|
||||
- eladmin-system 系统核心模块（系统启动入口）
|
||||
- sysrunner 程序启动后处理数据
|
||||
- modules 系统相关模块(登录授权、系统监控、定时任务、系统模块、运维模块)
|
||||
- eladmin-logging 系统日志模块
|
||||
- eladmin-tools 系统第三方工具模块
|
||||
- email 邮件工具
|
||||
- qiniu 七牛云存储工具
|
||||
- alipay 支付宝支付工具
|
||||
- local-storage 本地存储工具
|
||||
- eladmin-generator 系统代码生成模块
|
||||
- eladmin-common Public Module
|
||||
- annotation System custom annotations
|
||||
- aspect Custom annotation aspects
|
||||
- base Entity, DTO base classes, and MapStruct common mapper
|
||||
- config Project public configurations
|
||||
- Web configuration: cross-domain, static resource mapping, Swagger configuration, file upload temporary path configuration
|
||||
- Redis configuration, Redission configuration, asynchronous thread pool configuration
|
||||
- Permission interception configuration, AuthorityConfig, Druid delete advertisement configuration
|
||||
- exception Project unified exception handling
|
||||
- utils System utility classes, including:
|
||||
- BigDecimaUtils Amount calculation utility class
|
||||
- RequestHolder Request utility class
|
||||
- SecurityUtils Security utility class
|
||||
- StringUtils String utility class
|
||||
- SpringBeanHolder Spring Bean utility class
|
||||
- RedisUtils Redis utility class
|
||||
- EncryptUtils Encryption utility class
|
||||
- FileUtil File utility class
|
||||
- eladmin-system System Core Module (Project Entry Module)
|
||||
- sysrunner Program startup data processing
|
||||
- modules System-related modules (login authorization, system monitoring, scheduled tasks, system modules, operations management)
|
||||
- eladmin-logging System Log Module
|
||||
- eladmin-tools Third-party Tool Module
|
||||
- email Email tool
|
||||
- qiniu Qiniu cloud storage tool
|
||||
- alipay Alipay payment tool
|
||||
- local-storage Local storage tool
|
||||
- eladmin-generator System Code Generation Module
|
||||
```
|
||||
|
||||
#### 特别鸣谢
|
||||
## Special Thanks
|
||||
|
||||
- 感谢 [PanJiaChen](https://github.com/PanJiaChen/vue-element-admin) 大佬提供的前端模板
|
||||
- Thanks to [PanJiaChen](https://github.com/PanJiaChen/vue-element-admin) for providing the front-end template.
|
||||
- Thanks to [Moxun](https://github.com/moxun1639) for providing the front-end Curd common components.
|
||||
- Thanks to [zhy6599](https://gitee.com/zhy6599) for providing the back-end operations management related functions.
|
||||
- Thanks to [j.yao.SUSE](https://github.com/everhopingandwaiting) for providing the anonymous API and Redis rate limiting functions.
|
||||
- Thanks to [d15801543974](https://github.com/d15801543974) for providing the annotation-based common query method.
|
||||
|
||||
- 感谢 [Moxun](https://github.com/moxun1639) 大佬提供的前端 Curd 通用组件
|
||||
## Project Donation
|
||||
|
||||
- 感谢 [zhy6599](https://gitee.com/zhy6599) 大佬提供的后端运维管理相关功能
|
||||
The project's development relies on your support, please buy the author a cup of coffee ☕ [Donate](https://eladmin.vip/pages/030101/)
|
||||
|
||||
- 感谢 [j.yao.SUSE](https://github.com/everhopingandwaiting) 大佬提供的匿名接口与Redis限流等功能
|
||||
## Feedback and Discussion
|
||||
|
||||
- 感谢 [d15801543974](https://github.com/d15801543974) 大佬提供的基于注解的通用查询方式
|
||||
|
||||
#### 项目捐赠
|
||||
项目的发展离不开你的支持，请作者喝杯咖啡吧☕ [Donate](https://eladmin.vip/pages/030101/)
|
||||
|
||||
#### 反馈交流
|
||||
- QQ交流群：891137268 、947578238、659622532
|
||||
- QQ discussion group: 891137268, 947578238, 659622532
|
||||
Loading…
Reference in New Issue