Skip to content

Commit 78414cc

Browse files
springboot-plusspringboot-plus
committed
README.md
Former-commit-id: 5b5188037c172b54640dd244d35e934dbe078b3f
1 parent d1f5152 commit 78414cc

File tree

3 files changed

+162
-126
lines changed

3 files changed

+162
-126
lines changed

‎README-en.md‎

Lines changed: 0 additions & 71 deletions
This file was deleted.

‎README-zh.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<p align="center">
2+
<a href="https://github.com/geekidea/spring-boot-plus">
3+
<img alt="spring-boot-plus logo" src="https://raw.githubusercontent.com/geekidea/spring-boot-plus/dev/docs/img/logo.png">
4+
</a>
5+
</p>
6+
<p align="center">
7+
Everyone can develop projects independently, quickly and efficiently！
8+
</p>
9+
10+
<p align="center">
11+
<a href="https://github.com/geekidea/spring-boot-plus/">
12+
<img alt="spring-boot-plus version" src="https://img.shields.io/badge/spring--boot--plus-1.2.1--RELEASE-blue">
13+
</a>
14+
15+
<a href="https://github.com/spring-projects/spring-boot">
16+
<img alt="spring boot version" src="https://img.shields.io/badge/spring%20boot-2.1.7.RELEASE-brightgreen">
17+
</a>
18+
19+
<a href="https://www.apache.org/licenses/LICENSE-2.0">
20+
<img alt="code style" src="https://img.shields.io/badge/license-Apache%202-4EB1BA.svg?style=flat-square">
21+
</a>
22+
</p>
23+
24+
25+
#### SpringBoot Scaffolding
26+
27+
### spring-boot-plus是一套集成spring boot常用开发组件的后台快速开发框架
28+
29+
## Purpose
30+
> 每个人都可以独立、快速、高效地开发项目！
31+
32+
> Everyone can develop projects independently, quickly and efficiently！
33+
34+
## Quick Start
35+
#### 官网地址：[springboot.plus](http://springboot.plus "springboot.plus")
36+
#### GITHUB：[https://github.com/geekidea/spring-boot-plus](https://github.com/geekidea/spring-boot-plus "spring-boot-plus github")
37+
#### GITEE：[https://gitee.com/geekidea/spring-boot-plus](https://gitee.com/geekidea/spring-boot-plus "spring-boot-plus gitee")
38+
39+
# Architecture
40+
![spring-boot-plus-architecture.png](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-architecture.png)
41+
42+
43+
### 主要特性
44+
1. 集成spring boot 常用开发组件集、公共配置、AOP日志等
45+
2. 集成mybatis plus快速dao操作
46+
3. 快速生成后台代码: entity/param/vo/controller/service/mapper/xml
47+
4. 集成swagger2，可自动生成api文档
48+
5. 集成jwt、spring security权限控制
49+
6. 集成redis、spring cache、ehcache缓存
50+
7. 集成rabbit/rocket/kafka mq消息队列
51+
8. 集成druid连接池，JDBC性能和慢查询检测
52+
9. 集成spring boot admin，实时检测项目运行情况
53+
10. 使用assembly maven插件进行不同环境打包部署,包含启动、重启命令，配置文件提取到外部config目录
54+
55+
### 项目环境
56+
中间件 | 版本 | 备注
57+
-|-|-
58+
JDK | 1.8+ | JDK1.8及以上 |
59+
MySQL | 5.7+ | 5.7及以上 |
60+
Redis | 3.2+ | |
61+
62+
### 技术选型
63+
技术 | 版本 | 备注
64+
-|-|-
65+
Spring Boot | 2.1.7.RELEASE | 最新发布稳定版 |
66+
Spring Framework | 5.1.9.RELEASE | 最新发布稳定版 |
67+
Mybatis | 3.5.1 | 持久层框架 |
68+
Mybatis Plus | 3.1.2 | mybatis增强框架 |
69+
Alibaba Druid | 1.1.18 | 数据源 |
70+
Fastjson | 1.2.59 | JSON处理工具集 |
71+
swagger2 | 2.6.1 | api文档生成工具 |
72+
commons-lang3 | 3.9 | 常用工具包 |
73+
commons-io | 2.6 | IO工具包 |
74+
commons-codec | 1.12 | 加密解密等工具包 |
75+
commons-collections | 3.2.1 | 集合工具包 |
76+
reflections | 0.9.11 | 反射工具包 |
77+
hibernate-validator | 6.0.17.Final | 后台参数校验注解 |
78+
jwt | 0.9.1 | json web token |
79+
hutool-all | 4.5.10 | 常用工具集 |
80+
81+
82+
## spring-boot-plus QQ技术交流群
83+
![spring-boot-plus QQ技术交流群](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-qq-group.png)
84+
85+
86+
#### 官网地址：[springboot.plus](http://springboot.plus "springboot.plus")

‎README.md‎

Lines changed: 76 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -11,74 +11,95 @@
1111
<a href="https://github.com/geekidea/spring-boot-plus/">
1212
<img alt="spring-boot-plus version" src="https://img.shields.io/badge/spring--boot--plus-1.2.1--RELEASE-blue">
1313
</a>
14-
1514
<a href="https://github.com/spring-projects/spring-boot">
16-
<img alt="spring boot version" src="https://img.shields.io/badge/spring%20boot-2.1.7.RELEASE-brightgreen">
15+
<img alt="spring boot version" src="https://img.shields.io/badge/spring%20boot-2.1.6.RELEASE-brightgreen">
1716
</a>
18-
1917
<a href="https://www.apache.org/licenses/LICENSE-2.0">
2018
<img alt="code style" src="https://img.shields.io/badge/license-Apache%202-4EB1BA.svg?style=flat-square">
2119
</a>
2220
</p>
2321

24-
## Introduction
22+
## What is spring-boot-plus?
2523

26-
### spring-boot-plus是一套集成spring boot常用开发组件的后台快速开发框架
24+
### A **easy-to-use**, **high-speed**, **high-efficient**, **feature-rich**, **open source** spring boot scaffolding.
25+
> spring-boot-plus is a background rapid development framework that integrates spring boot common development components.
2726
2827
## Purpose
29-
> 每个人都可以独立、快速、高效地开发项目！
30-
3128
> Everyone can develop projects independently, quickly and efficiently！
3229
33-
## Quick Start
34-
#### 官网地址：[springboot.plus](http://springboot.plus "springboot.plus")
35-
#### GITHUB：[https://github.com/geekidea/spring-boot-plus](https://github.com/geekidea/spring-boot-plus "spring-boot-plus github")
36-
#### GITEE：[https://gitee.com/geekidea/spring-boot-plus](https://gitee.com/geekidea/spring-boot-plus "spring-boot-plus gitee")
37-
38-
![](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-architecture.png)
39-
40-
41-
### 主要特性
42-
1. 集成spring boot 常用开发组件集、公共配置、AOP日志等
43-
2. 集成mybatis plus快速dao操作
44-
3. 快速生成后台代码: entity/param/vo/controller/service/mapper/xml
45-
4. 集成swagger2，可自动生成api文档
46-
5. 集成jwt、spring security权限控制
47-
6. 集成redis、spring cache、ehcache缓存
48-
7. 集成rabbit/rocket/kafka mq消息队列
49-
8. 集成druid连接池，JDBC性能和慢查询检测
50-
9. 集成spring boot admin，实时检测项目运行情况
51-
10. 使用assembly maven插件进行不同环境打包部署,包含启动、重启命令，配置文件提取到外部config目录
52-
53-
### 项目环境
54-
中间件 | 版本 | 备注
30+
## DOCS
31+
#### [GITHUB](https://github.com/geekidea/spring-boot-plus) | [GITEE](https://gitee.com/geekidea/spring-boot-plus)
32+
33+
#### Website：[springboot.plus](http://springboot.plus "springboot.plus")
34+
35+
# Architecture
36+
![spring-boot-plus-architecture.png](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-architecture.png)
37+
38+
39+
## Features
40+
- Integrated spring boot common development component set, common configuration, AOP log, etc
41+
- Integrated mybatis-plus fast dao operation
42+
- Quickly generate background code:entity/param/vo/controller/service/mapper/xml
43+
- Integrated swagger2, automatic generation of api documents
44+
- Integrated JWT, spring security permission control
45+
- Integrated Redis、spring cache、ehcache,etc
46+
- Integrated Rabbit/Rocket/Kafka MQ
47+
- Integration alibaba druid connection pool, JDBC performance and slow query detection
48+
- Integrated Spring Boot Admin, real-time detection of project operation
49+
- Integrate maven-assembly-plugin for different environment package deployment, including startup and restart commands, and extract configuration files to external config directory
50+
51+
52+
### Project Environment
53+
Middleware | Version | Remark
5554
-|-|-
56-
JDK | 1.8+ | JDK1.8及以上 |
57-
MySQL | 5.7+ | 5.7及以上 |
55+
JDK | 1.8+ | JDK1.8 and above |
56+
MySQL | 5.7+ | 5.7 and above |
5857
Redis | 3.2+ | |
5958

60-
### 技术选型
61-
技术 | 版本 | 备注
59+
### Technology stack
60+
Component| Version | Remark
6261
-|-|-
63-
Spring Boot | 2.1.7.RELEASE | 最新发布稳定版 |
64-
Spring Framework | 5.1.9.RELEASE | 最新发布稳定版 |
65-
Mybatis | 3.5.1 | 持久层框架 |
66-
Mybatis Plus | 3.1.2 | mybatis增强框架 |
67-
Alibaba Druid | 1.1.18 | 数据源 |
68-
Fastjson | 1.2.59 | JSON处理工具集 |
69-
swagger2 | 2.6.1 | api文档生成工具 |
70-
commons-lang3 | 3.9 | 常用工具包 |
71-
commons-io | 2.6 | IO工具包 |
72-
commons-codec | 1.12 | 加密解密等工具包 |
73-
commons-collections | 3.2.1 | 集合工具包 |
74-
reflections | 0.9.11 | 反射工具包 |
75-
hibernate-validator | 6.0.17.Final | 后台参数校验注解 |
76-
jwt | 0.9.1 | json web token |
77-
hutool-all | 4.5.10 | 常用工具集 |
78-
79-
80-
## spring-boot-plus QQ技术交流群
81-
![spring-boot-plus QQ技术交流群](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-qq-group.png)
82-
83-
84-
#### 官网地址：[springboot.plus](http://springboot.plus "springboot.plus")
62+
Spring Boot | 2.1.7.RELEASE | Latest release stable version |
63+
Spring Framework | 5.1.9.RELEASE | Latest release stable version |
64+
Mybatis | 3.5.1 | DAO Framework |
65+
Mybatis Plus | 3.1.2 | mybatis Enhanced framework |
66+
Alibaba Druid | 1.1.18 | Data source |
67+
Fastjson | 1.2.59 | JSON processing toolset |
68+
swagger2 | 2.6.1 | Api document generation tool |
69+
commons-lang3 | 3.9 | Apache language toolkit |
70+
commons-io | 2.6 | Apache IO Toolkit |
71+
commons-codec | 1.12 | Apache Toolkit such as encryption and decryption |
72+
commons-collections | 3.2.1 | Apache collections toolkit |
73+
reflections | 0.9.11 | Reflection Toolkit |
74+
hibernate-validator | 6.0.17.Final | Validator toolkit |
75+
jwt | 0.9.1 | JSON WEB TOKEN |
76+
hutool-all | 4.5.10 | Common toolset |
77+
78+
## Getting started
79+
### Clone spring-boot-plus
80+
```bash
81+
git clone https://github.com/geekidea/spring-boot-plus.git
82+
cd spring-boot-plus
83+
```
84+
85+
### Maven Build
86+
> Local environment is used by default, The configuration file：application-local.yml
87+
```bash
88+
mvn clean package -Plocal
89+
```
90+
91+
## Quick Start
92+
[Quick Start](https://springboot.plus/guide/quick-start.html)
93+
94+
## Documentation
95+
[https://springboot.plus](https://springboot.plus)
96+
97+
## Contact
98+
- Gmail: [[email protected]](mailto:[email protected])
99+
- QQ Group
100+
101+
![spring-boot-plus QQ Group](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-qq-group.png)
102+
103+
104+
## License
105+
spring-boot-plus is under the Apache 2.0 license. See the [LICENSE](https://github.com/geekidea/spring-boot-plus/blob/master/LICENSE) file for details.

0 commit comments

Comments
 (0)