Skip to content

Commit

Permalink
docs(server doc): update server doc (#186)
Browse files Browse the repository at this point in the history
  • Loading branch information
RaoHai authored Jul 30, 2024
2 parents 12b62b2 + 0c479d9 commit 81f3d5a
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions server/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18"> [English](./README.md) | 简体中文

# 介绍
perter cat 服务端,采用 fastJSON 框架开发。
PeterCat 服务端,采用 FastAPI 框架开发。

# 功能模块
## github
Expand All @@ -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
Expand All @@ -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 、本地将能同步看到请求。
6. 在 demo repository 发起 issue 或者 pull-request,在 smee 、本地将能同步看到请求。

7. 在测试完毕后记得将 Webhook URL 改回去, eg:http://pertercat.chat/api/github/app/webhook

0 comments on commit 81f3d5a

Please sign in to comment.