Skip to content

Commit fef2ffe

Browse files
committed
update readme
1 parent 6823617 commit fef2ffe

File tree

2 files changed

+59
-42
lines changed

2 files changed

+59
-42
lines changed

README.md

Lines changed: 22 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525

2626
[在线文档](https://wenjianzhang.github.io/go-admin-site)
2727

28+
[视频教程](https://space.bilibili.com/565616721/channel/detail?cid=125737)
29+
2830
## ✨ 特性
2931

3032
- 遵循 RESTful API 设计规范
@@ -62,50 +64,29 @@
6264
8. 操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。
6365
9. 登录日志:系统登录日志记录查询包含登录异常。
6466
10. 系统接口:根据业务代码自动生成相关的api接口文档。
65-
11. 代码生成:根据数据表结构生成对应的增删改查相对应业务,全部可视化编程。
67+
11. 代码生成:根据数据表结构生成对应的增删改查相对应业务,全部可视化编程,基本业务可以0代码实现
6668
12. 表单构建:自定义页面样式,拖拉拽实现页面布局。
6769
13. 服务监控:查看一些服务器的基本信息。
6870

69-
## ⚙ 配置详情
70-
71-
1. 配置文件说明
72-
```yml
73-
settings:
74-
application:
75-
# 项目启动环境
76-
mode: dev # dev开发环境 test测试环境 prod线上环境;
77-
host: 0.0.0.0 # 主机ip 或者域名,默认0.0.0.0
78-
# 服务名称
79-
name: go-admin
80-
# 服务端口
81-
port: 8000
82-
readtimeout: 1
83-
writertimeout: 2
84-
log:
85-
# 日志文件存放路径
86-
dir: temp/logs
87-
jwt:
88-
# JWT加密字符串
89-
secret: go-admin
90-
# 过期时间单位:秒
91-
timeout: 3600
92-
database:
93-
# 数据库名称
94-
name: dbname
95-
# 数据库类型
96-
dbtype: mysql
97-
# 数据库地址
98-
host: 127.0.0.1
99-
# 数据库密码
100-
password: password
101-
# 数据库端口
102-
port: 3306
103-
# 数据库用户名
104-
username: root
105-
```
71+
## 准备工作
72+
73+
你需要在本地安装 [go] [gin] [node](http://nodejs.org/)[git](https://git-scm.com/)
74+
75+
同时配套了系列教程包含视频和文档,如何从下载完成到熟练使用,强烈建议大家先看完这些教程再来实践本项目!!!
76+
77+
### 轻松实现go-admin写出第一个应用 - 文档教程
78+
79+
[步骤一 - 基础内容介绍](http://doc.zhangwj.com/go-admin-site/guide/intro/tutorial01.html)
10680

107-
2. 文件路径 go-admin/config/settings.yml
81+
[步骤二 - 实际应用 - 编写增删改查](http://doc.zhangwj.com/go-admin-site/guide/intro/tutorial02.html)
10882

83+
### 手把手教你从入门到放弃 - 视频教程
84+
85+
[如何启动go-admin](https://www.bilibili.com/video/BV1z5411x7JG)
86+
87+
[使用生成工具轻松实现业务](https://www.bilibili.com/video/BV1Dg4y1i79D)
88+
89+
**如有问题请先看上述使用文档和文章,若不能满足,欢迎 issue 和 pr ,视频教程和文档持续更新中**
10990

11091
## 📦 本地开发
11192

@@ -121,7 +102,8 @@ cd ./go-admin
121102
# 编译项目
122103
go build
123104

124-
# 修改配置
105+
# 修改配置
106+
# 文件路径 go-admin/config/settings.yml
125107
vi ./config/setting.yml
126108

127109
# 1. 配置文件中修改数据库信息
@@ -140,8 +122,6 @@ vi ./config/setting.yml
140122
./go-admin server -c config/settings.yml -p 8000 -m dev
141123
142124
```
143-
[在线文档](https://wenjianzhang.github.io/go-admin-site)
144-
145125

146126
### 文档生成
147127
```bash

config/READMEN.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# ⚙ 配置详情
2+
3+
1. 配置文件说明
4+
```yml
5+
settings:
6+
application:
7+
# 项目启动环境
8+
mode: dev # dev开发环境 test测试环境 prod线上环境;
9+
host: 0.0.0.0 # 主机ip 或者域名,默认0.0.0.0
10+
# 服务名称
11+
name: go-admin
12+
# 服务端口
13+
port: 8000
14+
readtimeout: 1
15+
writertimeout: 2
16+
log:
17+
# 日志文件存放路径
18+
dir: temp/logs
19+
jwt:
20+
# JWT加密字符串
21+
secret: go-admin
22+
# 过期时间单位:秒
23+
timeout: 3600
24+
database:
25+
# 数据库名称
26+
name: dbname
27+
# 数据库类型
28+
dbtype: mysql
29+
# 数据库地址
30+
host: 127.0.0.1
31+
# 数据库密码
32+
password: password
33+
# 数据库端口
34+
port: 3306
35+
# 数据库用户名
36+
username: root
37+
```

0 commit comments

Comments
 (0)