Skip to content

Commit

Permalink
docs(wechat-public-account-push): 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
wangxinleo authored Sep 30, 2022
2 parents a7178ca + dfc34e5 commit 060349c
Show file tree
Hide file tree
Showing 8 changed files with 202 additions and 149 deletions.
135 changes: 61 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,35 +43,38 @@ wechat-public-account-push
- **网页自动生成配置插件**
- **支持gitee go / github actions 不需要拥有服务器,白嫖actions执行,每天定时发送**
- **支持本地化部署每天定时发送**
- **理论上支持所有远端的日志推送(目前仅支持测试号,没时间做)**
- **目前仅支持测试号**

---
[目录]

<!-- TOC depthFrom:2 -->

- [1. 如何使用](#1-如何使用以测试号为例)
- [1.1. 第一步:注册一个微信公众测试号](#11-第一步注册一个微信公众测试号)
- [1.2. 第二步:进行模板配置](#12-第二步进行模板配置)
- [1.3. 第三步:完成配置文件,并运行 wechat-public-account-push](#13-第三步完成配置文件并运行wechat-public-account-push)
- [1.3.1. 方式一:使用网页工具自动生成Github-Action配置(不准时,排队执行,胜在免费)](#131-方式一使用网页工具自动生成Github-Action配置不准时排队执行胜在免费)
- [1.3.2. 方式二:使用Github-Action(不准时,排队执行,胜在免费)](#132-方式二使用Github-Action不准时排队执行胜在免费)
- [1.3.3. 方式三:使用Gitee-go(定时任务收费,前200分钟免费,非常准时)](#133-方式三使用Gitee-go定时任务收费前200分钟免费非常准时)
- [1.3.4. 方式四:下载程序包到本地或服务器运行(需要有自己的服务器,使用系统的定时任务非常准时)](#134-方式四下载程序包到本地或服务器运行需要有自己的服务器使用系统的定时任务非常准时)
- [1.3.5. 方式五:使用云函数运行(需要使用运营商提供的 __付费__ 云函数功能,非常准时)](#135-方式五使用云函数运行需要使用运营商提供的-付费-云函数功能非常准时)
- [1. 如何使用](#1-如何使用)
- [1.1. 第一步:选用一个合适的消息通道](#11-第一步选用一个合适的消息通道)
- [1.2. 第二步:完成配置文件,并运行wechat-public-account-push](#12-第二步完成配置文件并运行wechat-public-account-push)
- [1.2.1 方式一:使用网页工具自动生成Github-Action配置(不准时,排队执行,胜在免费)](#121-方式一使用网页工具自动生成github-action配置不准时排队执行胜在免费)
- [1.2.2 方式二:使用Github-Action(不准时,排队执行,胜在免费)](#122-方式二使用github-action不准时排队执行胜在免费)
- [1.2.3 方式三:使用Gitee-go(定时任务收费,前200分钟免费,非常准时)](#123-方式三使用gitee-go定时任务收费前200分钟免费非常准时)
- [1.2.4 方式四:下载程序包到本地或服务器运行(需要有自己的服务器,使用系统的定时任务非常准时)](#124-方式四下载程序包到本地或服务器运行需要有自己的服务器使用系统的定时任务非常准时)
- [1.2.5 方式五:使用云函数运行(需要使用运营商提供的 __付费__ 云函数功能,非常准时)](#125-方式五使用云函数运行需要使用运营商提供的-付费-云函数功能非常准时)
- [2. 公众号模板参数说明](#2-公众号模板参数说明)
- [3. config参数说明](#3-config参数说明)
- [4. 常用的推送模板样例](#4-常用的推送模板样例)
- [5. GitHub/Gitee 如何更改自动执行时间](#5-githubgitee-如何更改自动执行时间)
- [5.1. github action如何更改自动执行时间](#51-github-action如何更改自动执行时间)
- [5.2. gitee go如何更改自动执行时间](#52-gitee-go如何更改自动执行时间)
- [5.1 github action如何更改自动执行时间](#51-github-action如何更改自动执行时间)
- [5.2 gitee go如何更改自动执行时间](#52-gitee-go如何更改自动执行时间)
- [6. 常见问题](#6-常见问题)
- [7. 版本发布及更新](#7-版本发布及更新)
- [7.1 重新fork](#71-重新fork)
- [7.2 GitHub Fetch Upstream Branch](#72-github-fetch-upstream-branch)
- [7.3 actions 脚本自动](#73-actions-脚本自动)
- [8. 成为开源贡献成员](#8-成为开源贡献成员)
- [8.1. 贡献代码](#81-贡献代码)
- [8.2. 贡献文档](#82-贡献文档)
- [8.1 贡献代码](#81-贡献代码)
- [8.2 贡献文档](#82-贡献文档)
- [9. 致谢](#9-致谢)
- [10. wechat-public-account-push 答疑群](#10-wechat\-public\-account\-push答疑群)
- [贡献/参与者](#贡献参与者)
- [10. wechat-public-account-push答疑群](#10-wechat-public-account-push答疑群)
- [11. 其他](#11-其他)

<!-- /TOC -->
Expand Down Expand Up @@ -101,76 +104,60 @@ wechat-public-account-push

![图片无法查看请移步顶部访问 国内备用仓库地址)](img/run-img-2.jpg)

## 1. 如何使用(以测试号为例)
## 1. 如何使用

wechat-public-account-push 实现自消息推送的原理,是通过调用一系列开放的api实现的, 所以也非常适合初学者学习。

**要使用 wechat-public-account-push, 我们只需要做拥有自己的公众号, 得到相关配置信息进行配置即可**
**要使用 wechat-public-account-push, 我们只需要选择合适的消息通道, 得到相关配置信息进行配置即可**

### 1.1. 第一步:注册一个微信公众测试号
### 1.1. 第一步:选用一个合适的消息通道

- 浏览器打开并登录 [微信公众测试号](https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=sandbox/login)
您可以在以下消息通道中选择一适合自己的消息通道

- 登录成功后, 就可以生成微信公众测试号的appID和appsecret这两串数字, 记下备用

![图片无法查看请移步顶部访问 国内备用仓库地址](img/wx-test-id.png)

- 扫描测试号二维码关注测试号, 扫描之后, 右边就会出现相应的已关注人员id, 记下备用

![图片无法查看请移步顶部访问 国内备用仓库地址](img/wx-test-follow.png)

### 1.2. 第二步:进行模板配置

新增测试模板, 点击 `新增测试模板` , 进行以下设置


> 这里面的每一个{{***.DATA}}都对应相应的数据,需要就保留,不需要就删掉

> **更多模板** 请查看上方更新内容
**推荐通道**

> iOS 可以无后台推送,推荐使用
>
> 2022年9月22日 Android 无法正常推送,MiPush 把 pushdeer 应用的推送权限暂停。原因是要求pushDeer审核推送内容。
模板标题: 自定义,例如: `亲爱的,早上好!`
⭐PushDeer >>>(接入中)

模板内容:

```
{{date.DATA}}  
城市:{{city.DATA}}  
天气:{{weather.DATA}}  
最低气温: {{min_temperature.DATA}}  
最高气温: {{max_temperature.DATA}}  
今天是我们恋爱的第{{love_day.DATA}}天
今天是我们结婚的第{{marry_day.DATA}}天
**其他通道**

{{birthday_message.DATA}}
> 测试号的标题不能修改为自定义的名称,不能修改测试号的头像
>
> 推送的消息必须要点进订阅号才能收到
>
> 每次要修改内容必须要自定义模版
>
> 此通道[可能会被腾讯弃用](https://developers.weixin.qq.com/community/minihome/doc/000a46c7eb8468ba1a1cc863e51401),请评估风险后再选择
{{one_talk.DATA}} -- {{talk_from.DATA}}
[⭐微信测试号 >>>](./docs/message-channel/test-number.md)

{{note_en.DATA}}  
{{note_ch.DATA}}
```
> 免费用户每天允许推送5条消息,付费用户每天1000条
>
> 消息放置在消息列表,方便随时查看
>
> 不再是xxxx测试号,而是方糖服务号,更美观
>
> 此通道[可能会被腾讯弃用](https://developers.weixin.qq.com/community/minihome/doc/000a46c7eb8468ba1a1cc863e51401),请评估风险后再选择
>
模板标题: `推送完成提醒`
⭐server酱服务号 >>>(接入中)

模板内容:
> 2022年6月20日后创建的应用需要填写可信IP,且可信IP不可公用,因此新应用无法按此配置通道
>
> 2022年9月23日后可信IP无法直接填写,需要验证企业域名才允许使用,意味着此方式将不再向个人提供服务
```
服务器信息:{{post_time_zone.DATA}} {{post_time.DATA}}
~~⭐企业微信应用消息 >>>~~(已删除)

共推送 {{need_post_num.DATA}}  人
成功: {{success_post_num.DATA}} | 失败: {{fail_post_num.DATA}}
成功用户: {{success_post_ids.DATA}}
失败用户: {{fail_post_ids.DATA}}
```

记下模板代码

![图片无法查看请移步顶部访问 国内备用仓库地址](img/wx-test-tmp.png)

### 1.3. 第三步:完成配置文件,并运行wechat-public-account-push
### 1.2. 第二步:完成配置文件,并运行wechat-public-account-push

#### 1.3.1 方式一:使用网页工具自动生成Github-Action配置(不准时,排队执行,胜在免费)
#### 1.2.1 方式一:使用网页工具自动生成Github-Action配置(不准时,排队执行,胜在免费)

> 以下为@shuangxunian ShuangxuNian大佬 提供的网页配置插件
>
Expand All @@ -182,28 +169,28 @@ wechat-public-account-push 实现自消息推送的原理,是通过调用一

[❓配置自动生成 教程 >>>](https://github.com/shuangxunian/wechat-form)

#### 1.3.2 方式二:使用Github-Action(不准时,排队执行,胜在免费)
#### 1.2.2 方式二:使用Github-Action(不准时,排队执行,胜在免费)
> 世界上最大的同性交友平台(不是),需要一定的英语基础,**编辑的时候请不要使用网页的自动翻译**
[❓Github-Action部署教程 >>>](./docs/github-actions.md)
[❓Github-Action部署教程 >>>](./docs/how-to-use/github-actions.md)

#### 1.3.3 方式三:使用Gitee-go(定时任务收费,前200分钟免费,非常准时)
#### 1.2.3 方式三:使用Gitee-go(定时任务收费,前200分钟免费,非常准时)
> 国产代码仓库,和github逻辑基本一致。全中文,对萌新友好。
[❓Gitee-Go部署教程 >>>](./docs/gitee-go.md)
[❓Gitee-Go部署教程 >>>](./docs/how-to-use/gitee-go.md)

#### 1.3.4 方式四:下载程序包到本地或服务器运行(需要有自己的服务器,使用系统的定时任务非常准时)
#### 1.2.4 方式四:下载程序包到本地或服务器运行(需要有自己的服务器,使用系统的定时任务非常准时)
> 如果是 Nodejs 开发者,直接 Clone 源码,然后 VS 打开后即可直接本地进行运行和调试。
>
> 对于不是开发者的朋友,可以通过以下教程到本地或任意服务器运行
[❓本地或在线服务器部署教程 >>>](./docs/run-in-server.md)
[❓本地或在线服务器部署教程 >>>](./docs/how-to-use/run-in-server.md)


#### 1.3.5 方式五:使用云函数运行(需要使用运营商提供的 __付费__ 云函数功能,非常准时)
#### 1.2.5 方式五:使用云函数运行(需要使用运营商提供的 __付费__ 云函数功能,非常准时)
>@ZzqiZQute zz 大佬提供代码迁移及教程编辑
[❓云函数部署教程 >>>](./docs/cloud-function.md)
[❓云函数部署教程 >>>](./docs/how-to-use/cloud-function.md)

## 2. 公众号模板参数说明

Expand Down Expand Up @@ -318,12 +305,12 @@ wechat-public-account-push 实现自消息推送的原理,是通过调用一
## 3. config参数说明
> 配置文件的详细说明,使用旧配置的小伙伴可以对照此文档增加新的配置
[❓config参数说明 >>>](./docs/config-demo.md)
[❓config参数说明 >>>](./docs/how-to-use/config-demo.md)

## 4. 常用的推送模板样例
> 收录一些常用好看的模板消息
[❓常用的推送模板样例 >>>](./docs/default-model.md)
[❓常用的推送模板样例 >>>](./docs/how-to-use/default-model.md)


## 5. GitHub/Gitee 如何更改自动执行时间
Expand Down
28 changes: 14 additions & 14 deletions docs/cloud-function.md → docs/how-to-use/cloud-function.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
[🪃返回首页 >>>](../README.md)
[📌返回首页 >>>](../../README.md)

# 云函数部署教程

以腾讯云函数为例(请 __登录__ 对应的运营商的平台,此处不再赘述)

Ⅰ. **创建云函数**
![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img.png)

![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_1.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_1.png)

![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_2.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_2.png)

![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_3.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_3.png)

II. **编辑代码**
![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_4.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_4.png)

将编辑器中的代码替换为以下代码
```js
Expand All @@ -26,7 +26,7 @@ exports.main_handler = async function () {

如图所示

![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_5.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_5.png)

III. **克隆仓库代码**

Expand All @@ -39,35 +39,35 @@ III. **克隆仓库代码**
cd src
git clone <你的仓库地址>
```
![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_6.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_6.png)

IV. **编辑config文件**

编辑仓库中的`config/index.cjs`文件,因为是在云函数上,因此APP_ID和APP_SECRET变量需要直接提供

![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_7.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_7.png)

V. **编译云函数需要的代码**

在终端中使用`cd`进入项目仓库,并运行以下脚本
```shell
npm run build-cloud
```
![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_8.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_8.png)

VI. **点击测试按钮进行测试**

![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_9.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_9.png)

如果正常推送,即配置正确,进行最后一部设置定时触发器操作。

VII. **设置定时触发器**

![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_10.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_10.png)

![图片无法查看请移步顶部访问 国内备用仓库地址](../img/cloud/img_11.png)
![图片无法查看请移步顶部访问 国内备用仓库地址](../../img/cloud/img_11.png)

其中Cron表达式即为定时触发的时间,可以点击[https://crontab.guru](https://crontab.guru)帮助配置


[🪃返回首页 >>>](../README.md)
[📌返回首页 >>>](../../README.md)
4 changes: 2 additions & 2 deletions docs/config-demo.md → docs/how-to-use/config-demo.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[🪃返回首页 >>>](../README.md)
[📌返回首页 >>>](../../README.md)

# config参数说明

Expand Down Expand Up @@ -341,4 +341,4 @@ module.exports = USER_CONFIG

```

[🪃返回首页 >>>](../README.md)
[📌返回首页 >>>](../../README.md)
4 changes: 2 additions & 2 deletions docs/default-model.md → docs/how-to-use/default-model.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[🪃返回首页 >>>](../README.md)
[📌返回首页 >>>](../../README.md)

# 常用的推送模板样例

Expand Down Expand Up @@ -61,4 +61,4 @@

![](../img/run-img-2.jpg)

[🪃返回首页 >>>](../README.md)
[📌返回首页 >>>](../../README.md)
Loading

0 comments on commit 060349c

Please sign in to comment.