Skip to content

Commit

Permalink
docs: update README && Dockerfile && openapi.yaml
Browse files Browse the repository at this point in the history
Signed-off-by: daz-3ux <[email protected]>
  • Loading branch information
Daz-3ux committed Oct 27, 2023
1 parent 278d195 commit 2a0ddd4
Show file tree
Hide file tree
Showing 7 changed files with 318 additions and 759 deletions.
8 changes: 6 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,12 @@ FROM ubuntu:devel AS final

WORKDIR /dBlog

RUN mkdir -p /var/log/dazblog && \
touch /var/log/dazblog/dazblog.log
RUN mkdir -p /var/log/dazblog &&\
mkdir -p /etc/ssl/certs/ &&\
touch /var/log/dazblog/dazblog.log && \
apt-get update && \
apt-get install curl -y


COPY --from=build /dBlog/_output/platforms/linux/amd64/dBlog /dBlog/_output/platforms/linux/amd64/dBlog
COPY --from=build /dBlog/_output/cert/ /dBlog/_output/cert
Expand Down
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# dazBlog
dazBlog 是一个基于 Go 语言开发的博客系统
使用了 `Golang` + `Gin` + `MySQL` + `Docker`
使用了 `Golang` + `Gin` + `MySQL` + `chatGPT` + `Docker`

## Features
- 使用了简洁架构,目录结构规范清晰
- 使用众多常用 Go 包
- 具备认证 (Gin JWT) 以及授权 (Casbin) 功能
- 使用 [langchaingo](https://github.com/tmc/langchaingo) 调用 OPENAI, 使用 GPT-3.5-turbo 模型总结文章内容
- 独立封装 log, error 包
- 使用 Makefile 高效管理项目
- 静态代码检查
Expand All @@ -16,6 +17,7 @@ dazBlog 是一个基于 Go 语言开发的博客系统
- 使用 MariaDB 存储数据
- RESTful API 设计规范以及 OpenAPI 3.0/Swagger 2.0 API 文档
- 支持 Docker 部署
- 接入腾讯公益 404 页面
- 完善的文档

## Installation
Expand All @@ -39,6 +41,8 @@ docker run --network=host \
-e DB_USER=your_db_user \
-e DB_PASSWORD=your_db_password \
-e DB_NAME=your_db_name \
-e OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxx \
-e OPENAI_MODEL=GPT-3.5-Trubo \
--restart always \
dazblog-image:latest
```
Expand All @@ -53,6 +57,8 @@ docker run --network=host \
-e DB_USER=your_db_user \
-e DB_PASSWORD=your_db_password \
-e DB_NAME=your_db_name \
-e OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxx \
-e OPENAI_MODEL=GPT-3.5-Trubo \
--restart always \
realdaz/dazblog
```
Expand Down Expand Up @@ -80,6 +86,13 @@ realdaz/dazblog
- 更新博客
- 删除博客
- 批量删除博客
- OPENAI 调用
- 创建 AI 内容分析
- 调用 OPENAI GPT-3.5-turbo 模型总结文章内容
- 获取 AI 内容
- 更新 AI 内容
- 列出 AI 内容
- 删除 AI 内容

### 业务架构模型
- 模型层 -- 控制层 -- 业务层 -- 仓库层
Expand Down Expand Up @@ -107,6 +120,9 @@ realdaz/dazblog
### HTTPS 的使用
[使用HTTPS](./docs/devel/zh-CN/conversions/https.md)

### OPENAI 的调用
[langchaingo](./docs/devel/zh-CN/conversions/GPT.md)

---

## License
Expand Down
Loading

0 comments on commit 2a0ddd4

Please sign in to comment.