Skip to content

Commit 8b288ed

Browse files
author
yadong.zhang
committed
项目readme文档完善并拆分,增加Issue和pr模板
1 parent 7deab44 commit 8b288ed

19 files changed

+144
-98
lines changed

.gitee/ISSUE_TEMPLATE.en.md

Whitespace-only changes.

.gitee/ISSUE_TEMPLATE.zh-CN.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### 该问题是怎么引起的?
2+
3+
### 复现步骤
4+
5+
### 报错信息

.gitee/ISSUE_TEMPLATE.zh-TW.md

Whitespace-only changes.

.gitee/PULL_REQUEST_TEMPLATE.en.md

Whitespace-only changes.

.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### 该PR关联的Issue(如果有)
2+
3+
### 修改描述
4+
5+
### 测试用例
6+
7+
### 效果截屏

.gitee/PULL_REQUEST_TEMPLATE.zh-TW.md

Whitespace-only changes.

README.md

+27-97
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1-
# DBlog简介
1+
# 关于DBlog
22
DBlog是一款简洁美观、自适应的Java博客系统。使用springboot开发,前端使用Bootstrap。支持移动端自适应,配有完备的前台和后台管理功能。
3+
![JDK](https://img.shields.io/badge/JDK-1.8-green.svg)
4+
![Maven](https://img.shields.io/badge/Maven-3.3.1-green.svg)
5+
![MySQL](https://img.shields.io/badge/MySQL-5.6.4-green.svg)
6+
![Redis](https://img.shields.io/badge/Redis-3.0.503-green.svg)
7+
[![license](https://img.shields.io/badge/license-MIT-yellow.svg)](https://gitee.com/yadong.zhang/DBlog/blob/master/LICENSE)
38

4-
# 注:请使用该项目的朋友优先查阅下【[Wiki](https://gitee.com/yadong.zhang/DBlog/wikis)
59

6-
群中好多朋友,现在仍在问的问题大都写在【[Wiki](https://gitee.com/yadong.zhang/DBlog/wikis)】中了,希望各位朋友能自己翻阅下相关资料,高效提问,避免重复问题。谢谢
10+
# 重要声明
711

8-
**网站预览**
9-
10-
[https://www.zhyd.me](https://www.zhyd.me)
11-
12-
**开源地址**
13-
1. [Gitee](https://gitee.com/yadong.zhang/DBlog)
14-
2. [Github](https://github.com/zhangyd-c/DBlog)
12+
1. 本项目配有相关[帮助文档](https://gitee.com/yadong.zhang/DBlog/wikis)。文档中包括**基本的项目说明****shiro标签使用****七牛云配置**和一些常见的**异常问题解决方案**。使用时碰到问题请**优先**查阅【[帮助文档](https://gitee.com/yadong.zhang/DBlog/wikis)】。因为现在好多朋友问的问题大部分都写在【[帮助文档](https://gitee.com/yadong.zhang/DBlog/wikis)】中了,希望各位朋友能自己翻阅下相关资料,高效提问,避免重复问题!
13+
2. **提问题**前请优先阅读【[如何向开源社区提问题](https://github.com/seajs/seajs/issues/545)】&【[提问的智慧](http://www.dianbo.org/9238/stone/tiwendezhihui.htm)
14+
3. **提问题**时请优先选择[Gitee Issues](https://gitee.com/yadong.zhang/DBlog/issues)(方便问题追踪和一对一解决),其次[我的博客-留言板](https://www.zhyd.me/guestbook),再次[QQ群190886500](http://shang.qq.com/wpa/qunwpa?idkey=9f986e9b33b1de953e1ef9a96cdeec990affd0ac7855e00ff103514de2027b60)(QQ群消息较多,提问请注意节奏、时机),最次加我QQ好友直接提问(不推荐)
15+
4. 本项目唯一官网:[https://www.zhyd.me](https://www.zhyd.me)
16+
5. 本项目开源地址:[Gitee](https://gitee.com/yadong.zhang/DBlog) 注:Github上的项目已不准备更新,因此版本较老,请Github用户移步至[Gitee](https://gitee.com/yadong.zhang/DBlog)
17+
6. 本项目修改记录,详情请移步[这里](https://gitee.com/yadong.zhang/DBlog/blob/master/update.md)
18+
7. 如果你想贡献代码,请先阅读[这篇文章](https://gitee.com/yadong.zhang/DBlog/blob/master/contribution.md)
1519

1620
## 写在前面的话
1721
ps: 虽然我知道,大部分人都是来了**直接下载源代码**后就潇洒的离开,并且只有等到下次**突然想到**“我天~~我得去看看DBlog这烂项目更新新功能了吗”的时候才会重新来到这儿,即使你重新来过,我估计你也只有两个选择:
@@ -21,18 +25,7 @@ ps: 虽然我知道,大部分人都是来了**直接下载源代码**后就潇
2125

2226
虽然我知道现实就是如此的残酷,但我还是要以我萤虫之力对各位到来的同仁发出一声诚挚的嘶吼:
2327

24-
**如果喜欢,请多多分享!!多多Star!!fork可以,但还是请star一下!!**
25-
26-
27-
### 开发环境
28-
29-
| 工具 | 版本或描述 |
30-
| ----- | -------------------- |
31-
| OS | Windows 7 |
32-
| JDK | 1.8+ |
33-
| IDE | IntelliJ IDEA 2017.3 |
34-
| Maven | 3.3.1 |
35-
| MySQL | 5.6.4 |
28+
**如果喜欢,请多多分享!!多多Star!!**
3629

3730
### 模块划分
3831

@@ -69,6 +62,7 @@ ps: 虽然我知道,大部分人都是来了**直接下载源代码**后就潇
6962
- 自研评论系统
7063
- 后台配备完善的权限管理
7164
- 自带robots、sitemap等seo模板,实现自动生成robots和sitemap
65+
- 集成七牛云,实现文件云存储
7266
- 系统配置支持快速配置。可通过后台手动修改诸如域名信息、SEO优化、赞赏码、七牛云以及更新维护通知等。
7367

7468

@@ -82,88 +76,24 @@ ps: 虽然我知道,大部分人都是来了**直接下载源代码**后就潇
8276
2. redis配置(在`resources/application.yml`配置文件中搜索`redis`或定位到L.65)
8377
3. mail配置(在`resources/application-{env}.yml`配置文件中搜索`mail`或定位到L.14)
8478
4.[七牛云](http://qiniu.com)】配置(见sys_config表中qiniu_*开头的字段)
85-
注:因为系统存在redis缓存,如果是第一次使用,可以直接修改sys_config表内容,如果不是第一次用,建议使用admin项目中的`系统配置`页面修改相关配置内容
79+
注:因为系统存在redis缓存,如果是第一次使用,可以直接修改sys_config表内容,如果不是第一次用,建议使用admin项目中的`系统配置`页面修改相关配置内容
8680
5. 运行项目(三种方式)
8781
1. 项目根目录下执行`mvn -X clean package -Dmaven.test.skip=true -Ptest`编译打包(注:-Ptest中的test为环境标识),然后cd到blog-web目录下执行`java -jar target/blog-web.jar`
8882
2. 项目根目录下执行`mvn springboot:run`
8983
3. 直接运行`BlogWebApplication.java`
9084
6. 浏览器访问`http://127.0.0.1:8443`
9185

9286

93-
**后台用户**
87+
**后台默认账户**
9488

95-
_超级管理员_: 账号:root 密码:123456 (本地测试使用这个账号,admin没设置权限)
89+
_超级管理员_(超级管理员): 账号:root 密码:123456
9690

97-
_普通管理员_: 账号:admin 密码:123456
91+
_普通管理员_(普通管理员,无权限): 账号:admin 密码:123456
9892

99-
_评论审核管理员_: 账号:comment-admin 密码:123456
93+
_评论审核管理员_(只有评论审核的权限): 账号:comment-admin 密码:123456
10094

10195
注:后台用户的创建,尽可能做到**权限最小化**
10296

103-
更多详情,请参考【[Wiki](https://gitee.com/yadong.zhang/DBlog/wikis)
104-
105-
### 更新日志
106-
2018-06-20
107-
108-
**修改功能:**
109-
110-
优化:
111-
升级Spring Boot至2.0.1版本及其他关联版本升级;
112-
使用Maven Profile管理Spring Boot Profiles,支持动态切换profile;
113-
114-
2018-06-10
115-
116-
**修改功能:**
117-
118-
新增:
119-
markdown版的编辑器、评论框
120-
控制文章的评论框是否显示
121-
修改密码功能
122-
优化:相关页面进行优化
123-
124-
2018-06-05
125-
126-
**修改功能:**
127-
128-
修复: admin用户首页报错的问题
129-
130-
优化:
131-
1. ROOT用户默认拥有所有权限
132-
2. admin页面改为macro引用的方式
133-
3. 登录界面
134-
4. 日志记录
135-
136-
2018-05-25
137-
138-
**修改功能:**
139-
140-
1. 修复后台标签等分页失败的问题
141-
2. 修复前台自动申请友链失败的问题
142-
3. 其他一些问题
143-
144-
145-
2018-05-22
146-
147-
**修改功能:**
148-
149-
1. 完善shiro权限(数据库、页面)。注:需要重新执行下`sys_resources``sys_role_resources`两张表的`insert`语句
150-
2. redis配置默认不含密码(鉴于大多数朋友的redis都没有密码做此修改,不过本人 **强烈建议**设置下密码)
151-
152-
2018-05-18
153-
154-
**修复bug:**
155-
156-
1. web端自动申请友链后不显示的问题
157-
2. config表修改后不能实时刷新的问题
158-
159-
**增加功能:**
160-
1. 网站赞赏码
161-
2. 百度推送功能(链接提交到百度站长平台)
162-
163-
**修改功能:**
164-
1. 百度api的ak和百度推送的token以及七牛云的配置改为通过config表管理
165-
3. admin模块菜单通过标签实时获取
166-
3. 弹窗工具类js结构调整
16797

16898
你能看到这儿已经很不容易了,剩下的自己先摸索摸索吧,实在不行,加QQ群[190886500](http://shang.qq.com/wpa/qunwpa?idkey=9f986e9b33b1de953e1ef9a96cdeec990affd0ac7855e00ff103514de2027b60),进群可以选择性的备注:~~欧巴群主我爱你~~(咳咳,鉴于部分群友的抗议,该备注就不用了),麻烦大家换成:`我猜群主一定很帅`
16999

@@ -182,17 +112,17 @@ _评论审核管理员_: 账号:comment-admin 密码:123456
182112
![角色列表](https://gitee.com/yadong.zhang/DBlog/raw/master/docs/img/admin-role.png?v=1.0)
183113
![角色分配](https://gitee.com/yadong.zhang/DBlog/raw/master/docs/img/admin-role2.png?v=1.0)
184114

185-
186-
### 生命不息,折腾不止! 更多信息,请关注:
115+
### 生命不息,折腾不止! 更多信息,请关注:
187116
1. [我的博客](https://www.zhyd.me)
188117
2. [我的微博](http://weibo.com/211230415)
189118
3. [我的头条号](http://www.toutiao.com/c/user/3286958681/)
190-
4. [我的mooc](http://www.imooc.com/u/1175248/articles)
119+
4. [我的imooc](http://www.imooc.com/u/1175248/articles)
191120

192-
### 有任何问题可以
193-
- [给我留言](https://www.zhyd.me/guestbook)
121+
### 特别感谢
194122

123+
1. 广大的开源爱好者
124+
2. 无私的网友
195125

196126
### 开源协议
197127

198-
[MIT](https://gitee.com/yadong.zhang/DBlog/blob/master/LICENSE)
128+
[![license](https://img.shields.io/badge/license-MIT-yellow.svg)](https://gitee.com/yadong.zhang/DBlog/blob/master/LICENSE)

blog-web/src/main/resources/templates/layout/footer.ftl

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@
162162
staticPath: '${config.staticWebSite}',
163163
qiuniuBasePath: '${config.qiuniuBasePath}',
164164
wxPraiseCode: '${config.wxPraiseCode}',
165-
zfbPraiseCode: '${config.zfbPraiseCode}',
165+
zfbPraiseCode: '${config.zfbPraiseCode}'
166166
}
167167
</script>
168168
<script type="text/javascript" src="${config.staticWebSite}/js/wangEditor.min.js"></script>

contribution.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# 代码贡献说明
2+
3+
1. 首先非常欢迎和感谢对本开源项目发起PR的朋友
4+
2. 本项目主要以【[阿里编程规约](https://yq.aliyun.com/attachment/download/?spm=a2c4e.11153940.blogcont69327.7.49d74b62D18YJE&id=5585)】作为规范进行开发,因此各位小伙伴有必要提前安装一个阿里编程规约插件。([Eclipse安装插件介绍](https://blog.csdn.net/qq_19260029/article/details/78259804?winzoom=1) & [Idea安装插件介绍](https://blog.csdn.net/lafengwnagzi/article/details/78246277)
5+
3. 代码提交前,请务必**格式化**一下代码,并且保证新增或者修改的方法都有完整的参数说明
6+
4. 请尽量编写相关单元测试
7+
8+
#### 贡献代码的方式
9+
10+
- `fork`本开源项目**到自己的仓库**,如`your/DBlog`,然后`clone`到本地(注意:是`clone``fork`后的**你的仓库**里的项目),并配置用户信息
11+
12+
```shell
13+
$ git clone https://gitee.com/your/DBlog.git
14+
$ cd DBlog
15+
$ git config user.name "your name"
16+
$ git config user.email "your email"
17+
```
18+
19+
- 本地修改代码后,推送到自己的仓库
20+
21+
```shell
22+
$ git commit -am "change something"
23+
$ git push origin master
24+
```
25+
26+
- 最后在你仓库里`fork`的项目里提交`Pull Request `即可
27+
28+
29+
详情参考:[http://git.mydoc.io/?t=153749](http://git.mydoc.io/?t=153749)

docs/img/admin-article2.png

-39.9 KB
Binary file not shown.

docs/img/admin-articles.png

-130 KB
Binary file not shown.

docs/img/admin-index.png

-97.3 KB
Binary file not shown.

docs/img/admin-menu.png

-39.4 KB
Binary file not shown.

docs/img/admin-role.png

-21 KB
Binary file not shown.

docs/img/admin-role2.png

-50 KB
Binary file not shown.

docs/img/m.png

-106 KB
Binary file not shown.

docs/img/pc-detail.png

-192 KB
Binary file not shown.

docs/img/pc-index.png

-216 KB
Binary file not shown.

update.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# 更新日志
2+
### 2018-06-27
3+
4+
**修改功能:**
5+
6+
优化:
7+
- @blogHeader宏标签数据动态获取
8+
- 开启websocket的逻辑调优,host从config表中获取
9+
- 项目readme文档完善并拆分
10+
- 项目maven版本修改为`2.0.1.Beta`
11+
12+
增加:
13+
- ISSUE和PR的模板
14+
15+
### 2018-06-20
16+
17+
**修改功能:**
18+
19+
优化:
20+
- 升级Spring Boot至2.0.1版本及其他关联版本升级;
21+
- 使用Maven Profile管理Spring Boot Profiles,支持动态切换profile;
22+
23+
### 2018-06-10
24+
25+
**修改功能:**
26+
27+
新增:
28+
- markdown版的编辑器、评论框
29+
- 控制文章的评论框是否显示
30+
- 修改密码功能
31+
优化:相关页面进行优化
32+
33+
### 2018-06-05
34+
35+
**修改功能:**
36+
37+
修复: admin用户首页报错的问题
38+
39+
优化:
40+
1. ROOT用户默认拥有所有权限
41+
2. admin页面改为macro引用的方式
42+
3. 登录界面
43+
4. 日志记录
44+
45+
### 2018-05-25
46+
47+
**修改功能:**
48+
49+
1. 修复后台标签等分页失败的问题
50+
2. 修复前台自动申请友链失败的问题
51+
3. 其他一些问题
52+
53+
54+
### 2018-05-22
55+
56+
**修改功能:**
57+
58+
1. 完善shiro权限(数据库、页面)。注:需要重新执行下`sys_resources``sys_role_resources`两张表的`insert`语句
59+
2. redis配置默认不含密码(鉴于大多数朋友的redis都没有密码做此修改,不过本人 **强烈建议**设置下密码)
60+
61+
### 2018-05-18
62+
63+
**修复bug:**
64+
65+
1. web端自动申请友链后不显示的问题
66+
2. config表修改后不能实时刷新的问题
67+
68+
**增加功能:**
69+
1. 网站赞赏码
70+
2. 百度推送功能(链接提交到百度站长平台)
71+
72+
**修改功能:**
73+
1. 百度api的ak和百度推送的token以及七牛云的配置改为通过config表管理
74+
3. admin模块菜单通过标签实时获取
75+
3. 弹窗工具类js结构调整

0 commit comments

Comments
 (0)