Skip to content

Commit

Permalink
docs(README): 完善运行文档,补充必要说明和步骤
Browse files Browse the repository at this point in the history
  • Loading branch information
Penryn committed Nov 19, 2024
1 parent 1cfdd66 commit 97b1599
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@
```

### 如何运行
1. 克隆该项目
1. 克隆该项目的开发分支
```
git clone https://github.com/zjutjh/4UOnline-Go.git
git clone -b dev https://github.com/zjutjh/4UOnline-Go.git
```
2. 更改配置文件,并按注释要求填写database、redis、user和wechat的配置
2. 更改配置文件,并按注释要求填写database、redis、user和wechat的配置(user(用户中心)配置询问部长团,并要提供个人学号,wechat不为空就行)
```
mv config.example.yaml config.yaml
```
Expand All @@ -50,7 +50,7 @@ go run main.go
go run main.go
```
5. 每次提交commit前,先运行以下代码检查后端
使用[golangci-lint](https://golangci-lint.run/)检查代码
使用[golangci-lint](https://golangci-lint.run/)(v1.16.0)检查代码(其他版本会有其他报错,先以这个版本为主)
```
golangci-lint run --config .golangci.yml
```
Expand Down
3 changes: 1 addition & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,8 @@ github.com/gorilla/securecookie v1.1.1/go.mod h1:ra0sb63/xPlUeL+yeDciTfxMRAA+MP+
github.com/gorilla/securecookie v1.1.2 h1:YCIWL56dvtr73r6715mJs5ZvhtnY73hBvEF8kXD8ePA=
github.com/gorilla/securecookie v1.1.2/go.mod h1:NfCASbcHqRSY+3a8tlWJwsQap2VX5pwzwo4h3eOamfo=
github.com/gorilla/sessions v1.1.1/go.mod h1:8KCfur6+4Mqcc6S0FEfKuN15Vl5MgXW92AE8ovaJD0w=
github.com/gorilla/sessions v1.3.0 h1:XYlkq7KcpOB2ZhHBPv5WpjMIxrQosiZanfoy1HLZFzg=
github.com/gorilla/sessions v1.3.0/go.mod h1:ePLdVu+jbEgHH+KWw8I1z2wqd0BAdAQh/8LRvBeoNcQ=
github.com/gorilla/sessions v1.4.0 h1:kpIYOp/oi6MG/p5PgxApU8srsSw9tuFbt46Lt7auzqQ=
github.com/gorilla/sessions v1.4.0/go.mod h1:FLWm50oby91+hl7p/wRxDth9bWSuk0qVL2emc7lT5ik=
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI=
github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
Expand Down

0 comments on commit 97b1599

Please sign in to comment.