From 0c479d90f495d4ef671043e9ea8735f808e6f9c5 Mon Sep 17 00:00:00 2001 From: ch-liuzhide Date: Tue, 30 Jul 2024 11:08:40 +0800 Subject: [PATCH] docs(server doc): updatee server doc --- server/README.zh-CN.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/server/README.zh-CN.md b/server/README.zh-CN.md index db61f778..ccae84be 100644 --- a/server/README.zh-CN.md +++ b/server/README.zh-CN.md @@ -1,7 +1,7 @@ [English](./README.md) | 简体中文 # 介绍 -perter cat 服务端，采用 fastJSON 框架开发。 +PeterCat 服务端，采用 FastAPI 框架开发。 # 功能模块 ## github @@ -14,7 +14,7 @@ perter cat 服务端，采用 fastJSON 框架开发。 2. 访问 [smee.io](https://smee.io/) 新建一个 channel,得到形如 https://smee.io/Q2VVS0casGnhZV 的 url 。 -3. 本地启动此 server,得到 hook 服务地址 +3. 本地启动此 server, 得到 hook 服务地址 ```bash # 项目根目录启动 server yarn run server @@ -27,10 +27,13 @@ yarn run server yarn global add smee-client # 绑定 channel smee -u https://smee.io/Q2VVS0casGnhZV -t http://127.0.0.1:8000/api/github/app/webhook - ``` +``` + +5. 访问 [demo repository settings ](https://github.com/{ORG_NAME}/{REPO_NAME}/settings/installations) -5. 访问 [demo repository settings ](https://github.com/ant-xuexiao/demo-repository/settings/installations) -\> 配置 perter-cat 插件 [settings](https://github.com/organizations/ant-xuexiao/settings/apps/petercat-bot) \> +\> 配置 perter-cat 插件 [settings](https://github.com/organizations/{ORG_NAME}/settings/apps/petercat-bot) \> Webhook URL \> 填入smee channel url, eg: https://smee.io/Q2VVS0casGnhZV -6. 在 demo repository 发起 issue 或者 pull-request，在 smee 、本地将能同步看到请求。 \ No newline at end of file +6. 在 demo repository 发起 issue 或者 pull-request，在 smee 、本地将能同步看到请求。 + +7. 在测试完毕后记得将 Webhook URL 改回去, eg:http://pertercat.chat/api/github/app/webhook \ No newline at end of file