Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caomeiyouren/wechat-official-helper
一个基于 Hono 实现的云函数版本的微信公众号助手，支持个人非认证公众号的上行登录、用户消息存储等功能，支持 OAuth2.0 登录
https://github.com/caomeiyouren/wechat-official-helper
hono oauth2 serverless vercel wechat wechat-app wechat-official-account
Last synced: 14 days ago
JSON representation
一个基于 Hono 实现的云函数版本的微信公众号助手，支持个人非认证公众号的上行登录、用户消息存储等功能，支持 OAuth2.0 登录
- Host: GitHub
- URL: https://github.com/caomeiyouren/wechat-official-helper
- Owner: CaoMeiYouRen
- License: agpl-3.0
- Created: 2024-09-23T14:38:05.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-10-21T14:58:50.000Z (16 days ago)
- Last Synced: 2024-10-21T18:05:24.669Z (16 days ago)
- Topics: hono, oauth2, serverless, vercel, wechat, wechat-app, wechat-official-account
- Language: TypeScript
- Homepage: https://wx.cmyr.dev/
- Size: 564 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
wechat-official-helper
> 一个基于 Hono 实现的云函数版本的微信公众号助手，支持个人非认证公众号的上行登录、用户消息存储等功能，支持 OAuth2.0 登录。
## 🏠 主页
[https://github.com/CaoMeiYouRen/wechat-official-helper#readme](https://github.com/CaoMeiYouRen/wechat-official-helper#readme)
## 📦 依赖要求
- node >=20
## 🚀 部署
### Vercel 部署（推荐）
点击以下按钮一键部署到 Vercel。
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCaoMeiYouRen%2Fwechat-official-helper.git)
### Docker 镜像
支持两种注册表：
- Docker Hub: [`caomeiyouren/wechat-official-helper`](https://hub.docker.com/r/caomeiyouren/wechat-official-helper)
- GitHub: [`ghcr.io/caomeiyouren/wechat-official-helper`](https://github.com/CaoMeiYouRen/wechat-official-helper/pkgs/container/wechat-official-helper)
支持以下架构：
- `linux/amd64`
- `linux/arm64`
有以下几种 tags：
| Tag | 描述 | 举例 |
| :------------- | :------- | :------------ |
| `latest` | 最新 | `latest` |
| `{YYYY-MM-DD}` | 特定日期 | `2024-06-07` |
| `{sha-hash}` | 特定提交 | `sha-0891338` |
| `{version}` | 特定版本 | `1.2.3` |
### Docker Compose 部署
下载 [docker-compose.yml](https://github.com/CaoMeiYouRen/wechat-official-helper/blob/master/docker-compose.yml)
```sh
wget https://raw.githubusercontent.com/CaoMeiYouRen/wechat-official-helper/refs/heads/master/docker-compose.yml
```
检查有无需要修改的配置
```sh
vim docker-compose.yml # 也可以是你喜欢的编辑器
```
> 在公网部署时请务必修改 WX_TOKEN、DATABASE_URL、ADMIN_KEY、JWT_SECRET、CLIENT_SECRET 等环境变量。
>
> 具体请查看 `.env` 文件。
启动
```sh
docker-compose up -d
```
在浏览器中打开 `http://{Server IP}:3000` 即可查看结果
### Node.js 部署
确保本地已安装 Node.js 和 pnpm。
```sh
# 下载源码
git clone https://github.com/CaoMeiYouRen/wechat-official-helper.git --depth=1
cd wechat-official-helper
# 安装依赖
pnpm i --frozen-lockfile
# 构建项目
pnpm build
# 启动项目
pnpm start
```
在浏览器中打开 `http://{Server IP}:3000` 即可查看结果
## 👨💻 使用
如果在本地部署，基础路径为 `http://localhost:3000`
在服务器或云函数部署则为 `http(s)://{Server IP}`。
例如：
如果基础路径为 `https://example.vercel.app`，则 `/event` 的完整路径为 `https://example.vercel.app/event`
### 响应微信公众号消息
> 待完善
### OAuth2.0 登录
> 待完善
## 🛠️ 开发
```sh
npm run dev
```
## 🔧 编译
```sh
npm run build
```
## 🔍 Lint
```sh
npm run lint
```
## 💾 Commit
```sh
npm run commit
```
## 👤 作者
**CaoMeiYouRen**
* Website: [https://blog.cmyr.ltd/](https://blog.cmyr.ltd/)
* GitHub: [@CaoMeiYouRen](https://github.com/CaoMeiYouRen)
## 🤝 贡献
欢迎 贡献、提问或提出新功能！
如有问题请查看 [issues page](https://github.com/CaoMeiYouRen/wechat-official-helper/issues).
贡献或提出新功能可以查看[contributing guide](https://github.com/CaoMeiYouRen/wechat-official-helper/blob/master/CONTRIBUTING.md).
## 💰 支持
如果觉得这个项目有用的话请给一颗⭐️，非常感谢
## 🌟 Star History
[](https://star-history.com/#CaoMeiYouRen/wechat-official-helper&Date)
## 📝 License
Copyright © 2024 [CaoMeiYouRen](https://github.com/CaoMeiYouRen).
This project is [AGPL-3.0](https://github.com/CaoMeiYouRen/wechat-official-helper/blob/master/LICENSE) licensed.
***
_This README was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_