[U] readme

zxysilent · Apr 13, 2021 · 97299cb · 97299cb
1 parent 819b39c
commit 97299cb
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -1,80 +1,122 @@
-### 一个 go语言实现的博客 
-#### 技术栈
-- golang
-- vue
-- echo 框架
-- 前台界面目前修改于 https://firekylin.org/
-
-### 预览地址
-
-[https://blog.zxysilent.com/](https://blog.zxysilent.com/)
-
-### 开发原因 
+## 一个 go语言实现的博客 
+## A blog written in the go programming language 
+
+### 技术栈
+### Technology stack 
+- golang [https://golang.google.cn](https://golang.google.cn)
+- vue [https://cn.vuejs.org](https://cn.vuejs.org)
+- xorm [https://xorm.io](https://xorm.io)
+- echo [https://echo.labstack.com](https://echo.labstack.com)
+- iview [https://www.iviewui.com](https://www.iviewui.com)
+- UI 修改于 [https://firekylin.org](https://firekylin.org)
+
+## 预览地址
+## Preview address 
+[https://blog.zxysilent.com](https://blog.zxysilent.com)
+
+## 开发原因 
 - 现在自己使用博客系统不方便管理、部署和二次开发
 - 渲染速度到不到想要的效果
 
-### 计划功能
-实现```blog```功能和基本```cms```功能,提取快速开发框架和通用后台管理界面
+## 计划功能
+实现```blog```功能和基本```cms```功能,提取快速开发框架和```通用后台管理```
 - [x] 文章管理
 - [x] 页面管理
 - [x] 分类管理
 - [x] 标签管理
 - [x] 系统设置
 - [x] 管理主页
+- [x] 菜单权限
+## 说明
 
-### tips
-
-- 替换markdown 编辑器为富文本编辑器即可作为`CMS`  
+- 替换markdown 编辑器为富文本编辑器即可作为`CMS` 
 [https://github.com/zxysilent/view-design-admin](https://github.com/zxysilent/view-design-admin)
 
 - 富文本预览地址  
-[http://76.zxysilent.com/demos/view-design-admin/index.html#/pages/editor](http://76.zxysilent.com/demos/view-design-admin/index.html#/pages/editor)
+[http://qn.static.zxysilent.com/demos/view-design-admin/index.html#/pages/editor](http://qn.static.zxysilent.com/demos/view-design-admin/index.html#/pages/editor)
 
-### 讨论群
+## 讨论群
 🐧🐧 1059282178
 
-### 使用方式
+## 使用方式-直接部署
 ```
-git clone https://github.com/zxysilent/blog.git
+git clone -b v0.1.0 --depth=1 https://github.com/zxysilent/blog.git
 ```
 若要部署，请修改关键信息[jwt、用户名、密码等]
 数据库自带文章内容请在部署前删除
 
-####  运行服务
+### 部署界面
+- 安装依赖```npm install```
+- 发布```npm run build```会自动发布到```dist```目录下面
+- 友链里面第一个为后台登陆地址默认用户名```zxysilent```,密码```zxyslt```，可自行数据库修改
+### 部署服务
 - 配置```conf.toml```数据库信息
-- 还原 ```data```目录下 ```db.sql``` 数据库
+- 还原```data```目录下```db.sql```数据库
 数据库自带文章内容请在部署前删除
-- 安装依赖
-- 安装 swag   
-    ```go get -u github.com/swaggo/swag/cmd/swag```
-- 运行```swag init ```生成api文档
-- 运行后台 ```go run```  
+- 安装依赖```go mod tidy```
+- 编译可执行程序 
+    - 普通开发编译版本```go build```
+    - 编译不带日志和swagger文档版本```go build -tags=prod```体积大幅度减小,日志请用```nginx、caddy```等```web```服务器记录
+    - 若需要日志且不需要文档，请自定义开发或提issues
+- 服务器部署
+    - windows 直接运行
+    - linux 普通方式```nohup ./blog>>nohup.log 2>&1 &```
 
-####  运行后台
-- 安装依赖 ``` npm install ```
-- 开发运行 ``` npm run serve ```
-- 浏览器打开 [http://127.0.0.1:8080/](http://127.0.0.1:8080/)
-- 发布 ```npm run build ``` 会自动发布到 ```dist```目录下面
-- 友链里面第一个为后台登陆地址默认用户名```zxysilent```,密码```zxyslt```，可自行数据库修改
 ### 评论配置
 - 配置项目 opts(表).comment(值) 
 - 配置说明 [https://github.com/gitalk/gitalk](https://github.com/gitalk/gitalk)
+
+## 使用方式-自定义开发
+```
+git clone https://github.com/zxysilent/blog.git
+```
+若要部署，请修改关键信息[jwt、用户名、密码等]
+数据库自带文章内容请在部署前删除
+
+### 开发界面
+- 安装依赖```npm install```
+- 开发运行```npm run serve```
+- 浏览器打开 [http://127.0.0.1:8080/](http://127.0.0.1:8080/)
+- 友链里面第一个为后台登陆地址默认用户名```zxysilent```,密码```zxyslt```，可自行数据库修改
+###  开发服务
+- 配置```conf.toml```数据库信息
+- 还原```data```目录下```db.dev.sql```数据库
+数据库自带文章内容请在部署前删除
+- 安装依赖```go mod tidy```
+- 安装 swag   
+    - ```go get -u github.com/swaggo/swag/cmd/swag```
+- 运行```swag init```生成api文档
+- 运行后台```go run```
+- 浏览器默认访问 [http://127.0.0.1:8085/](http://127.0.0.1:8085/)
+
 ## 渲染性能
 ![image](./data/imgs/benchmark.png)
 
 ## 效果展示
 
 ### 前台
+- 首页
 ![image](./data/imgs/front-0.png)
+- 归档
 ![image](./data/imgs/front-1.png)
+- 关于
 ![image](./data/imgs/front-2.png)
 
 ### 后台
-![image](./data/imgs/backend-0.png)![image](./data/imgs/backend-1.png)
+- 登录
+![image](./data/imgs/backend-0.png)
+- 首页
+![image](./data/imgs/backend-1.png)
+- 文章
 ![image](./data/imgs/backend-2.png)
+- 文章编辑
 ![image](./data/imgs/backend-3.png)
+- 配置
 ![image](./data/imgs/backend-4.png)
-
+- 菜单
+![image](./data/imgs/backend-5.png)
+- 角色
+![image](./data/imgs/backend-6.png)
 ## Donation
 If this project help you a lot, you can support us by:
 

diff --git a/data/imgs/backend-5.png b/data/imgs/backend-5.png
diff --git a/data/imgs/backend-6.png b/data/imgs/backend-6.png