Wrest Chat 项目教程-优快云博客

Wrest Chat 项目教程

wrest-chat 微信机器人，PC Wechat Api/Bot/Sdk，内置 WEB 管理界面，可接入GPT、Gemini 、星火、文心、混元、通义千问等大语言模型项目地址: https://gitcode.com/gh_mirrors/wr/wrest-chat

1. 项目目录结构及介绍

Wrest Chat 项目的目录结构如下：

wrest-chat/
├── docs/
├── github/
│   └── workflows/
├── dbase/
├── docker/
├── httpd/
├── public/
├── wcferry/
├── wclient/
├── webview/
├── .gitignore
├── LICENSE
├── README.md
├── build.bat
├── build.sh
├── config.yml
├── go.mod
├── go.sum
├── main.go
└── start-dev.bat

目录介绍

docs/: 存放项目文档的目录。
github/workflows/: 存放 GitHub Actions 工作流的目录。
dbase/: 数据库相关文件的目录。
docker/: Docker 相关文件的目录。
httpd/: HTTP 服务器相关文件的目录。
public/: 公共资源文件的目录。
wcferry/: WeChatFerry 相关文件的目录。
wclient/: 客户端相关文件的目录。
webview/: Web 视图相关文件的目录。
.gitignore: Git 忽略文件配置。
LICENSE: 项目许可证文件。
README.md: 项目说明文件。
build.bat: Windows 平台下的构建脚本。
build.sh: Linux/Mac 平台下的构建脚本。
config.yml: 项目配置文件。
go.mod: Go 模块依赖文件。
go.sum: Go 模块依赖校验文件。
main.go: 项目主入口文件。
start-dev.bat: 开发环境启动脚本。

2. 项目启动文件介绍

`main.go`

main.go 是 Wrest Chat 项目的主入口文件。它负责初始化项目并启动服务。以下是 main.go 的主要功能：

初始化配置文件。
启动 HTTP 服务器。
启动 Websocket 服务器。
初始化 AI 机器人。
启动 Web 管理界面。

`start-dev.bat`

start-dev.bat 是开发环境下的启动脚本。它主要用于在 Windows 平台上快速启动项目，方便开发人员进行调试和测试。

3. 项目配置文件介绍

`config.yml`

config.yml 是 Wrest Chat 项目的配置文件。它包含了项目的各种配置选项，如 HTTP 接口配置、Websocket 接口配置、AI 机器人配置等。以下是 config.yml 的主要配置项：

http:
  port: 8080
  auth: true

websocket:
  port: 8081

ai:
  model: "GPT"
  api_key: "your_api_key"

web:
  admin_user: "admin"
  admin_password: "password"

配置项介绍

http: HTTP 服务器配置。
- port: HTTP 服务器的端口号。
- auth: 是否启用 HTTP 接口授权。
websocket: Websocket 服务器配置。
- port: Websocket 服务器的端口号。
ai: AI 机器人配置。
- model: 使用的 AI 模型，如 "GPT"、"Gemini" 等。
- api_key: AI 模型的 API 密钥。
web: Web 管理界面配置。
- admin_user: 管理员用户名。
- admin_password: 管理员密码。