Merge pull request #153 from sjtu-jiaojiao/develop

quality

README.md

@@ -2,4 +2,4 @@
 [![Build Status](https://travis-ci.com/sjtu-jiaojiao/SJTU-JiaoJiao.svg?branch=master)](https://travis-ci.com/sjtu-jiaojiao/SJTU-JiaoJiao) [![Coverage Status](https://coveralls.io/repos/github/sjtu-jiaojiao/SJTU-JiaoJiao/badge.svg?branch=master)](https://coveralls.io/github/sjtu-jiaojiao/SJTU-JiaoJiao?branch=master) ![License](https://img.shields.io/badge/License-GPL--3.0-orange.svg) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/91ef9a75205240eaa6b97281b500de0b)](https://www.codacy.com/app/sjtu-jiaojiao/SJTU-JiaoJiao?utm_source=github.com&utm_medium=referral&utm_content=sjtu-jiaojiao/SJTU-JiaoJiao&utm_campaign=Badge_Grade) [![Go Report Card](https://goreportcard.com/badge/github.com/sjtu-jiaojiao/SJTU-JiaoJiao)](https://goreportcard.com/report/github.com/sjtu-jiaojiao/SJTU-JiaoJiao)
 
 ## Tools
-  - gitflow.sh: 自动配置gitflow.
+- gitflow.sh: 自动配置gitflow.

backend/CHANGELOG.md

@@ -5,46 +5,46 @@
 
 ## v0.1.3 2019-07-23
 ### 恢复
- 1. `AddContent`、`DeleteContent`、`AddAvatar`接口恢复使用
+1. `AddContent`、`DeleteContent`、`AddAvatar`接口恢复使用
 
 ### 新增
- 1. `POST /buyInfo` 添加求购信息
- 2. `GET /buyInfo/:buyInfoId` 查询求购信息详情
- 3. `GET /buyInfo` 按条件查询求购信息
- 4. `PUT /content` 修改content
- 5. `GET /sellInfo` 支持更多查询条件
+1. `POST /buyInfo` 添加求购信息
+2. `GET /buyInfo/:buyInfoId` 查询求购信息详情
+3. `GET /buyInfo` 按条件查询求购信息
+4. `PUT /content` 修改content
+5. `GET /sellInfo` 支持更多查询条件
 
 ### 参数修改
- 1. 图片上传大小限制为5M
- 2. 视频上传大小限制为50M
+1. 图片上传大小限制为5M
+2. 视频上传大小限制为50M
 
 ## v0.1.2 2019-07-20
 ### 禁用
- 1. `AddContent`、`DeleteContent`、`AddAvatar`接口已声明但功能暂不可用
+1. `AddContent`、`DeleteContent`、`AddAvatar`接口已声明但功能暂不可用
 
 ### 新增
- 1. `GET /file/:fileId` 获取文件
- 2. `POST /avatar` 添加头像（暂不可用）
+1. `GET /file/:fileId` 获取文件
+2. `POST /avatar` 添加头像（暂不可用）
 
 ### API修改
- 1. API参数错误将统一返回400
- 2. `PUT /sellInfo` 修改为POST
- 3. `PUT /content` 修改为POST
- 4. `PUT /user` 修改为POST
- 5. `POST /user` 修改为PUT
+1. API参数错误将统一返回400
+2. `PUT /sellInfo` 修改为POST
+3. `PUT /content` 修改为POST
+4. `PUT /user` 修改为POST
+5. `POST /user` 修改为PUT
 
 ### 权限修改
- 1. `GET /user/:userId` 允许管理员访问
- 2. `PUT /user` 用户自身不允许修改部分字段
+1. `GET /user/:userId` 允许管理员访问
+2. `PUT /user` 用户自身不允许修改部分字段
 
 ## v0.1.1 2019-07-17
 ### 新增
- 1. `GET /auth` 登陆接口添加状态码3为用户被冻结
- 2. `GET/PUT /user` 用户查询添加`role`字段标识用户身份
+1. `GET /auth` 登陆接口添加状态码3为用户被冻结
+2. `GET/PUT /user` 用户查询添加`role`字段标识用户身份
 
 ### BUG修复
- 1. `GET /sellInfo/:sellInfoId` 返回字段`sellInfoState`修正为`status`（文档错误实际返回正常）
- 2. `PUT /content` 修复`content`字段检测问题
+1. `GET /sellInfo/:sellInfoId` 返回字段`sellInfoState`修正为`status`（文档错误实际返回正常）
+2. `PUT /content` 修复`content`字段检测问题
 
 ## v0.1.0 2019-07-17
 第一个稳定版本

backend/README.md

@@ -1,26 +1,26 @@
 # 后端
 ## 环境依赖
-  - golang
-  - consul
-  - nodejs/npm
-  - 建议系统环境为Linux系统，windows下可能出现各种问题
+- golang
+- consul
+- nodejs/npm
+- 建议系统环境为Linux系统，windows下可能出现各种问题
 
 依赖安装：
 
     make deps
 
 ## 本地开发
 ### Makefile一键命令
-  - 查看帮助：`make` 或 `make help`
-  - 依赖安装：`make deps`
-  - 构建二进制文件：`make build`
-  - 构建docker：`make docker`
-  - 单元测试：`make test`
-  - 清理目录：`make clean`
-  - 生成文档：`make doc`
-  - 生成proto：`make proto`
-  - 添加新服务：`make add`
-  - 部署服务：`make deploy` （**警告：本地开发禁用**）
+- 查看帮助：`make` 或 `make help`
+- 依赖安装：`make deps`
+- 构建二进制文件：`make build`
+- 构建docker：`make docker`
+- 单元测试：`make test`
+- 清理目录：`make clean`
+- 生成文档：`make doc`
+- 生成proto：`make proto`
+- 添加新服务：`make add`
+- 部署服务：`make deploy` （**警告：本地开发禁用**）
 
 ### 服务管理程序
 一键启动：
@@ -34,41 +34,41 @@ windows:
     go run run.go run_windows.go
 
 ## 本地服务默认地址
-  - consul服务：`localhost:8500`
-  - micro web：`localhost:8082`
-  - APIGateway：`localhost:8080`
-  - goconvey：`localhost:8400`
-  - realize热启动：`localhost:5002`
-  - API地址：`localhost:8080/[version]/[service]/[router]`
-  - doc文档：`localhost:8080/[version]/doc`
+- consul服务：`localhost:8500`
+- micro web：`localhost:8082`
+- APIGateway：`localhost:8080`
+- goconvey：`localhost:8400`
+- realize热启动：`localhost:5002`
+- API地址：`localhost:8080/[version]/[service]/[router]`
+- doc文档：`localhost:8080/[version]/doc`
 
 ## 配置
-  - 依赖管理采用go mod，建议使用最新版golang。
-  - 国内网络建议使用goproxy以加快依赖下载速度。
-  - `config.json` 为总配置文件，项目配置请在 `consul.json` 中添加以支持配置中心。
+- 依赖管理采用go mod，建议使用最新版golang。
+- 国内网络建议使用goproxy以加快依赖下载速度。
+- `config.json` 为总配置文件，项目配置请在 `consul.json` 中添加以支持配置中心。
 
 ### 配置文件
 `config.json` 配置：
 
-  - `deploy`：部署设置，`develop` 为开发模式，`product` 为生产模式
-  - `hosts`：服务地址配置
-    - `consul_*`：consul服务地址
-    - `url_*`：url地址
-    - `test_*`：测试配置，请勿修改
-  - `config_ttl`：远程配置超时时间（秒）
-  - `test`：测试配置，请勿修改
+- `deploy`：部署设置，`develop` 为开发模式，`product` 为生产模式
+- `hosts`：服务地址配置
+  - `consul_*`：consul服务地址
+  - `url_*`：url地址
+  - `test_*`：测试配置，请勿修改
+- `config_ttl`：远程配置超时时间（秒）
+- `test`：测试配置，请勿修改
 
 ### 环境变量
 **环境变量设置敏感信息，相关内容禁止提交到仓库**
 
-  - `JJ_CONFIGPATH`：config路径，覆盖默认值，发布二进制文件需设置
-  - `JJ_CLIENTID`：OAuth client_id
-  - `JJ_CLIENTSECRET`：OAuth client_secret
-  - `JJ_MARIADBUSER`：MariaDB用户名
-  - `JJ_MARIADBPWD`：MariaDB密码
-  - `JJ_MONGODBUSER`：MongoDB用户名
-  - `JJ_MONGODBPWD`：MongoDB密码
-  - `JJ_JWTSECRET`：JWT secretkey
+- `JJ_CONFIGPATH`：config路径，覆盖默认值，发布二进制文件需设置
+- `JJ_CLIENTID`：OAuth client_id
+- `JJ_CLIENTSECRET`：OAuth client_secret
+- `JJ_MARIADBUSER`：MariaDB用户名
+- `JJ_MARIADBPWD`：MariaDB密码
+- `JJ_MONGODBUSER`：MongoDB用户名
+- `JJ_MONGODBPWD`：MongoDB密码
+- `JJ_JWTSECRET`：JWT secretkey
 
 ## 目录结构
 
@@ -83,8 +83,8 @@ windows:
 ## JWT Token
 token存在三个字段：
 
-  - `id`：唯一id
-  - `role`：用户身份
-    - 1：用户
-    - 10：系统管理员
-  - `exp`：过期时间，默认30分钟
+- `id`：唯一id
+- `role`：用户身份
+  - 1：用户
+  - 10：系统管理员
+- `exp`：过期时间，默认30分钟

docs/README.md

@@ -1,4 +1,4 @@
 # SJTU-JiaoJiao document
 Here is all documents about SJTU-JiaoJiao.
 
-  - workflow.md: Introduce git workflow of the project.
+- workflow.md: Introduce git workflow of the project.

docs/golang-style.md

@@ -2,7 +2,7 @@
 doc文件不方便版本控制，先放这里稳定后再合并
 
 参考：
-  - [Effective Go](https://golang.org/doc/effective_go.html)
+- [Effective Go](https://golang.org/doc/effective_go.html)
 
 ## 自动格式化
 请使用`goimports`，默认配置即可。

docs/workflow.md

@@ -4,11 +4,11 @@
 *nix系统可以使用根目录下的`gitflow.sh`自动初始化gitflow环境。
 
 ## 分支
-  - master: 稳定分支. PR必须从`develop`分支合并且有4人通过review（目前为小组全体成员）
-  - develop: 当前开发分支，可能存在bug或不稳定新特性. PR必须有至少1人review
-  - feature/[name]: feature 分支
-  - bugfix/[name]: bugfix 分支
-  - hotfix/[name]: hotfix 分支
+- master: 稳定分支. PR必须从`develop`分支合并且有4人通过review（目前为小组全体成员）
+- develop: 当前开发分支，可能存在bug或不稳定新特性. PR必须有至少1人review
+- feature/[name]: feature 分支
+- bugfix/[name]: bugfix 分支
+- hotfix/[name]: hotfix 分支
 
 ## 创建新feature
 使用下面的命令创建新特性并提交远程