Let's use AI to Earn!
TypeScript auto-publishdouyindouyin-apielectron-appelectron-reactkuaishoukwaipublishedshipinhaotoolxiaohongshu
feat: README.md
Nevin39ffbacc5462
diff --git a/aitoearn_web/CHANNEL_Md/BILIBILI.md b/aitoearn_web/CHANNEL_Md/BILIBILI.mdnew file mode 100644index 00000000..8467c7a1--- /dev/null+++ b/aitoearn_web/CHANNEL_Md/BILIBILI.md@@ -0,0 +1,9 @@+# Bilibili 指南++1. bilibili:https://open.bilibili.com/company-core+ - 创建应用-选择网页应用+ - 填写基础资料和应用回调域(服务的域名)+ - 填写回调域名:http://localhost:8080/api/v1/channel/bilibili/callback+2. 填写配置+ - 配置文件:`aitoearn-channel/config/local.config.js`+ - 填写 `bilibili` 配置\ No newline at end of filediff --git a/aitoearn_web/CHANNEL_Md/BILIBILI_EN.md b/aitoearn_web/CHANNEL_Md/BILIBILI_EN.mdnew file mode 100644index 00000000..8bcab7fc--- /dev/null+++ b/aitoearn_web/CHANNEL_Md/BILIBILI_EN.md@@ -0,0 +1,9 @@+# Bilibili Guide++1. Bilibili: https://open.bilibili.com/company-core+ - Create an application - Select Web Application+ - Fill in basic information and application callback domain (service domain)+ - Fill in callback domain: http://localhost:8080/api/v1/channel/bilibili/callback+2. Fill in configuration+ - Configuration file: `aitoearn-channel/config/local.config.js`+ - Fill in `bilibili` configuration\ No newline at end of filediff --git a/aitoearn_web/CHANNEL_Md/WXPLAT.md b/aitoearn_web/CHANNEL_Md/WXPLAT.mdnew file mode 100644index 00000000..0b02a214--- /dev/null+++ b/aitoearn_web/CHANNEL_Md/WXPLAT.md@@ -0,0 +1,16 @@+# 微信三方平台 指南+1. 注意:因为微信只能填写一个回调地址,以及有域名白名单,ip地址白名单等限制,所以把微信第三方单独抽离做了一个服务,该服务同时服务多个环境++2. 微信三方平台申请:https://open.weixin.qq.com+ - 创建应用:管理中心>第三方平台>创建第三方平台+ - 填写应用信息+ - 填写开发配置+ - 授权事件接收配置:`https://{host}/wxPlat/callback/ticket` // 用于接收票据+ - 消息与事件接收配置`https://{host}/wxPlat/callback/msg/$APPID$` // 用于接收事件消息+ - 授权发起页域名`https://{host}` // 授权页面域名+ - 配置文件+ - 配置文件:`aitoearn-wxplat/config/local.config.js`+ - 配置项:`wxPlat`+ 其中`authBackHost` 填写你的aitoearn-wxplat服务域名+ `msgUrlList` 转发给aitoearn-channel的消息的域名列表+ `authUrlMap` 不同环境的授权回调地址diff --git a/aitoearn_web/CHANNEL_Md/WXPLAT_EN.md b/aitoearn_web/CHANNEL_Md/WXPLAT_EN.mdnew file mode 100644index 00000000..e769f7c9--- /dev/null+++ b/aitoearn_web/CHANNEL_Md/WXPLAT_EN.md@@ -0,0 +1,16 @@+# WeChat Third-Party Platform Guide+1. Note: Because WeChat can only fill in one callback address, and there are restrictions such as domain name whitelist and IP address whitelist, the WeChat third-party service has been separated to serve multiple environments simultaneously.++2. WeChat third-party platform application: https://open.weixin.qq.com+ - Create application: Management Center > Third-Party Platform > Create Third-Party Platform+ - Fill in application information+ - Fill in development configuration+ - Authorization event receiving configuration: `https://{host}/wxPlat/callback/ticket` // Used to receive tickets+ - Message and event receiving configuration: `https://{host}/wxPlat/callback/msg/$APPID$` // Used to receive event messages+ - Authorization initiation page domain: `https://{host}` // Authorization page domain+ - Configuration file+ - Configuration file: `aitoearn-wxplat/config/local.config.js`+ - Configuration item: `wxPlat`+ `authBackHost`: Fill in your aitoearn-wxplat service domain+ `msgUrlList`: Domain list for forwarding messages to aitoearn-channel+ `authUrlMap`: Authorization callback addresses for different environments\ No newline at end of filediff --git a/aitoearn_web/CONTRIBUTING.md b/aitoearn_web/CONTRIBUTING.mdnew file mode 100644index 00000000..f50de1d2--- /dev/null+++ b/aitoearn_web/CONTRIBUTING.md@@ -0,0 +1,57 @@+# 贡献指南++感谢您对 AiToEarn 项目的关注!我们欢迎任何形式的贡献,包括但不限于提交 bug 报告、功能请求、代码改进和文档完善。++## 目录++- [贡献指南](#贡献指南)+ - [目录](#目录)+ - [行为准则](#行为准则)+ - [开发环境搭建](#开发环境搭建)+ - [提交 Pull Request](#提交-pull-request)+ - [报告 Bug](#报告-bug)+ - [建议新功能](#建议新功能)+ - [代码审查](#代码审查)++## 行为准则++请遵守我们的行为准则,确保所有参与者都能在一个开放和友好的环境中进行交流。++## 开发环境搭建++1. Fork 项目到自己的 GitHub 账户+2. 创建功能分支:+ ```bash+ git checkout -b feature/your-feature-name+ ```+3. 提交更改:+ ```bash+ git add .+ git commit -m "feat: add new feature"+ ```+4. 推送到 Fork 的仓库:+ ```bash+ git push origin feature/your-feature-name+ ```+5. 在 GitHub 上创建 Pull Request++## 报告 Bug+1. 确保 bug 没有被其他 issue 所报告+2. 创建一个新 issue,并填写以下信息:+ - 描述 bug 的标题+ - 描述 bug 的详细内容+ - 步骤来复现 bug+ - 截图(如果有)+ - 其他信息(如错误日志、堆栈跟踪等)+## 建议新功能+1. 确保新功能没有被其他 issue 所报告+2. 创建一个新 issue,并填写以下信息:+ - 描述新功能的标题+ - 描述新功能的详细内容+ - 截图(如果有)+## 代码审查+1. 创建一个 pull request+2. 等待其他贡献者进行代码审查+3. 修改代码并提交新的 commit+4. 推送新的 commit 到你的 fork 的仓库+5. 确保 pull request 被合并到主仓库\ No newline at end of filediff --git a/aitoearn_web/CONTRIBUTING_EN.md b/aitoearn_web/CONTRIBUTING_EN.mdnew file mode 100644index 00000000..305b325e--- /dev/null+++ b/aitoearn_web/CONTRIBUTING_EN.md@@ -0,0 +1,57 @@+# Contribution Guide++Thank you for your interest in the AiToEarn project! We welcome all forms of contributions, including but not limited to bug reports, feature requests, code improvements, and documentation enhancements.++## Table of Contents++- [Contribution Guide](#contribution-guide)+ - [Table of Contents](#table-of-contents)+ - [Code of Conduct](#code-of-conduct)+ - [Development Environment Setup](#development-environment-setup)+ - [Submitting Pull Requests](#submitting-pull-requests)+ - [Reporting Bugs](#reporting-bugs)+ - [Suggesting New Features](#suggesting-new-features)+ - [Code Review](#code-review)++## Code of Conduct++Please follow our code of conduct to ensure all participants can communicate in an open and friendly environment.++## Development Environment Setup++1. Fork the project to your own GitHub account+2. Create a feature branch:+ ```bash+ git checkout -b feature/your-feature-name+ ```+3. Commit your changes:+ ```bash+ git add .+ git commit -m "feat: add new feature"+ ```+4. Push to your forked repository:+ ```bash+ git push origin feature/your-feature-name+ ```+5. Create a Pull Request on GitHub++## Reporting Bugs+1. Ensure the bug has not been reported in other issues+2. Create a new issue and include the following information:+ - Title describing the bug+ - Detailed description of the bug+ - Steps to reproduce the bug+ - Screenshots (if available)+ - Other information (such as error logs, stack traces, etc.)+## Suggesting New Features+1. Ensure the feature has not been requested in other issues+2. Create a new issue and include the following information:+ - Title describing the new feature+ - Detailed description of the new feature+ - Screenshots (if available)+## Code Review+1. Create a pull request+2. Wait for other contributors to review the code+3. Modify the code and commit the new changes+4. Push the new commits to your forked repository+5. Ensure the pull request is merged into the main repository\ No newline at end of filediff --git a/aitoearn_web/README.md b/aitoearn_web/README.mdindex 0e0bca01..de03750d 100644--- a/aitoearn_web/README.md+++ b/aitoearn_web/README.md@@ -3,14 +3,16 @@* @Date: 2025-01-17 19:25:28* @LastEditTime: 2025-02-24 19:37:13* @LastEditors: nevin- * @Description:+ * @Description:--># AiToEarn Web+[English](README_EN.md) | 简体中文## 项目介绍-AiToEarn的WEB项目,web端实现:+AiToEarn 的 WEB 项目,实现多平台内容发布的 Web 端应用。支持以下 12 个主流社交媒体平台:+<div style="display: flex; gap: 15px; align-items: center; flex-wrap: wrap; margin: 20px 0;"><img src="https://lf1-cdn-tos.bytegoofy.com/goofy/ies/douyin_web/public/favicon.ico" title="抖音" alt="抖音" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'"><img src="https://i0.hdslb.com/bfs/static/jinkela/long/images/favicon.ico" title="B站" alt="B站" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">@@ -25,12 +27,36 @@ AiToEarn的WEB项目,web端实现:<img src="https://s.pinimg.com/webapp/logo_transparent_144x144-3da7a67b.png" title="Pinterest" alt="Pinterest" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'"></div>-抖音、小红书、快手、bilibili、公众号、 Tiktok、Youtube、Facebook、Instagram、Threads、Twitter、Pinterest等12个平台的矩阵发布+**支持平台矩阵发布:** 抖音、小红书、快手、Bilibili、微信公众号、Tiktok、Youtube、Facebook、Instagram、Threads、Twitter、Pinterest++项目地址:[Aitoearn](https://aitoearn.ai)++## 目录结构++### Web 前端++**技术栈:**+- React+- TypeScript+- next-## 后端模块+**启动命令:**+```bash+pnpm run dev+```++### 服务端++**技术栈:**+- NestJS nodejs 框架+- NATS 消息队列+- MongoDB+- Redis+- AWS S3+- BullMQ-1. `aitoearn-gateway` - 网关模块-```tree+#### 1. `aitoearn-gateway` - 网关模块+```├── config 不同环境的配置文件│├── src@@ -44,8 +70,9 @@ AiToEarn的WEB项目,web端实现:│ ├── transports 通信模块│ └── views 视图```-2. `aitoearn-channel` - 渠道模块-```tree++#### 2. `aitoearn-channel` - 渠道模块+```├── config 不同环境的配置文件(各个三方平台的开发者key和密钥,微信三方平台在aitoearn-wxplay项目配置文件配置)│├── src@@ -64,41 +91,70 @@ AiToEarn的WEB项目,web端实现:│ ├── transports 通信模块│ └── views```-3. `aitoearn-user` - 用户模块-4. `aitoearn-wxplat` - 微信三方平台服务(解耦开发环境)-## 后端技术栈+#### 3. `aitoearn-user` - 用户模块-- NestJS nodejs 框架-- NATS 消息队列-- MongoDB-- Redis-- AWS S3-- BullMQ+#### 4. `aitoearn-wxplat` - 微信三方平台服务(解耦开发环境)-## 使用方法+**快速启动:**+```bash+npm run dev:local+```+## MCP服务++### 1. 配置平台账号++在前端页面添加平台账号:+<img src="./workflow/img/account.jpeg" alt="添加平台账号" width="500"/>++### 2. 创建关联多个账号的 `skkey`++<img src="./workflow/img/skkey.jpg" alt="创建skkey" width="500"/>-1. 分别启动后端服务模块:- 本地启动:config目录下创建local.config.js文件(复制dev.config.js文件修改配置)- ```sh- pnpm i- pnpm run dev:local- ```-2. 启动前端项目:`aitoearn-web`- ```sh- pnpm i- pnpm run dev- ```-3. 在前端页面进行添加平台账号-<img src="./workflow/img/account.jpeg" alt="post" width="500"/>--4. 创建关联多个账号的 `skkey`-<img src="./workflow/img/skkey.jpg" alt="post" width="500"/>--4. 在工作流平台创建工作流(或导入模板-workflow文件夹)-5. 在工作流的参数设置使用 `skkey` 进行内容发布-<img src="./workflow/img/fl.jpeg" alt="post" width="500"/>--## 工作流平台使用的接口+### 3. 创建和配置工作流+- 在工作流平台创建工作流(或导入模板-workflow文件夹)+- 在工作流的参数设置中使用 `skkey` 进行内容发布+<img src="./workflow/img/fl.jpeg" alt="工作流发布" width="500"/>++### 工作流平台使用的接口`aitoearn-channel\src\core\mcp\plugin.controller.ts`++## 高级设置+### 平台申请和设置 ###+1. [Bilibili](CHANNEL_Md/BILIBILI.md)+1. [微信三方平台](CHANNEL_Md/WXPLAT.md)++++## 计划+- 添加更多平台+- 添加更多功能++## 使用方法++### 1. 启动后端服务模块++本地启动:在 config 目录下创建 `local.config.js` 文件(复制 `dev.config.js` 文件并修改配置)++```bash+pnpm install+pnpm run dev:local+```++### 2. 启动前端项目 `aitoearn-web`++```bash+pnpm install+pnpm run dev+```+## 贡献指南++请查看 [贡献指南](CONTRIBUTING.md) 了解如何参与项目开发。++## 联系我们++如有任何问题,请通过以下方式联系我们:++- 提交 GitHub Issues+- 发送邮件至 [[email protected]](mailto:[email protected])\ No newline at end of filediff --git a/aitoearn_web/README_EN.md b/aitoearn_web/README_EN.mdindex 4d0637a3..ee8f0d8b 100644--- a/aitoearn_web/README_EN.md+++ b/aitoearn_web/README_EN.md@@ -3,32 +3,60 @@* @Date: 2025-01-17 19:25:28* @LastEditTime: 2025-02-24 19:37:13* @LastEditors: nevin- * @Description:+ * @Description:--># AiToEarn Web-[简体中文](README.md) | English++[English](README_EN.md) | 简体中文## Project Introduction-AiToEarn WEB project implements matrix publishing across 11 platforms on the web side:-- Douyin- Bilibili- Kuaishou- WeChat Official Accounts- YouTube- Twitter- TikTok- Facebook- Instagram- Threads- Pinterest-Matrix publishing across 11 platforms--## Backend Modules--1. `aitoearn-gateway` - Gateway module-```tree+AiToEarn's WEB project is a web application that implements multi-platform content publishing. It supports the following 12 major social media platforms:++<div style="display: flex; gap: 15px; align-items: center; flex-wrap: wrap; margin: 20px 0;">+ <img src="https://lf1-cdn-tos.bytegoofy.com/goofy/ies/douyin_web/public/favicon.ico" title="抖音" alt="抖音" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://i0.hdslb.com/bfs/static/jinkela/long/images/favicon.ico" title="B站" alt="B站" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://s1-111422.kwimgs.com/kos/nlav111422/ks-web/favicon.ico" title="快手" alt="快手" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://res.wx.qq.com/a/wx_fed/assets/res/NTI4MWU5.ico" title="微信公众号" alt="微信公众号" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://www.youtube.com/s/desktop/3ad23781/img/logos/favicon.ico" title="YouTube" alt="YouTube" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://abs.twimg.com/responsive-web/client-web/icon-svg.ea5ff4aa.svg" title="Twitter" alt="Twitter" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://www.tiktok.com/favicon.ico" title="TikTok" alt="TikTok" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://static.xx.fbcdn.net/rsrc.php/y1/r/ay1hV6OlegS.ico" title="Facebook" alt="Facebook" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://static.cdninstagram.com/rsrc.php/y4/r/QaBlI0OZiks.ico" title="Instagram" alt="Instagram" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://static.cdninstagram.com/rsrc.php/ye/r/lEu8iVizmNW.ico" title="Threads" alt="Threads" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+ <img src="https://s.pinimg.com/webapp/logo_transparent_144x144-3da7a67b.png" title="Pinterest" alt="Pinterest" width="32" height="32" style="object-fit: contain; transition: transform 0.3s;" onmouseover="this.style.transform='scale(1.2)'" onmouseout="this.style.transform='scale(1)'">+</div>++**Supported Platforms for Matrix Publishing:** Douyin, Xiaohongshu, Kuaishou, Bilibili, WeChat Official Accounts, TikTok, YouTube, Facebook, Instagram, Threads, Twitter, Pinterest++Project URL: [Aitoearn](https://aitoearn.ai)++## Directory Structure++### Web Frontend++**Technology Stack:**+- React+- TypeScript+- next++**Startup Command:**+```bash+pnpm run dev+```++### Backend++**Technology Stack:**+- NestJS Node.js framework+- NATS message queue+- MongoDB+- Redis+- AWS S3+- BullMQ++#### 1. `aitoearn-gateway` - Gateway Module+```├── config Configuration files for different environments│├── src@@ -42,10 +70,10 @@ Matrix publishing across 11 platforms│ ├── transports Communication module│ └── views Views```-2. aitoearn-channel - Channel module-```tree-├── config-│ Configuration files for different environments (Developer keys and keys of various third-party platforms,The wechat third-party platform is configured in the │ aitoearn-wxplay project configuration file)++#### 2. `aitoearn-channel` - Channel Module+```+├── config Configuration files for different environments (developer keys and secrets for various third-party platforms, WeChat third-party platform configured in aitoearn-wxplay project configuration file)│├── src│ ├── common Common module@@ -63,34 +91,70 @@ Matrix publishing across 11 platforms│ ├── transports Communication module│ └── views```-3. aitoearn-user - User module-4. aitoearn-wxplat - WeChat third-party platform service (decoupled development environment)--## Backend Technology Stack-NestJS Node.js framework-NATS Message queue-MongoDB-Redis-AWS S3-BullMQ-## Usage Instructions-1. Start backend service modules separately: Local startup: Create local.config.js file in config directory (copy dev.config.js file and modify configuration)-```sh-pnpm i++#### 3. `aitoearn-user` - User Module++#### 4. `aitoearn-wxplat` - WeChat Third-Party Platform Service (Decoupled Development Environment)++**Quick Start:**+```bash+npm run dev:local+```+## MCP Service++### 1. Configure Platform Accounts++Add platform accounts on the frontend page:+<img src="./workflow/img/account.jpeg" alt="Add Platform Account" width="500"/>++### 2. Create `skkey` Associated with Multiple Accounts++<img src="./workflow/img/skkey.jpg" alt="Create skkey" width="500"/>++### 3. Create and Configure Workflows++- Create workflows on the workflow platform (or import templates from the workflow folder)+- Use `skkey` in workflow parameter settings for content publishing+<img src="./workflow/img/fl.jpeg" alt="Workflow Publishing" width="500"/>++### Interface Used by Workflow Platform+`aitoearn-channel\src\core\mcp\plugin.controller.ts`++## Advanced Settings+### Platform Application and Setup ###+1. [Bilibili](CHANNEL_Md/BILIBILI_EN.md)+1. [WeChat Third-Party Platform](CHANNEL_Md/WXPLAT_EN.md)++++## Roadmap+- Add more platforms+- Add more features++## Usage++### 1. Start Backend Service Modules++Local startup: Create a `local.config.js` file in the config directory (copy the `dev.config.js` file and modify the configuration)++```bash+pnpm installpnpm run dev:local```-2. Start frontend project: aitoearn-web-```sh-pnpm i++### 2. Start Frontend Project `aitoearn-web`++```bash+pnpm installpnpm run dev```-3. Add platform accounts on the frontend page- <img src="./workflow/img/account.jpeg" alt="post" width="500"/>-4. Create skkey associated with multiple accounts- <img src="./workflow/img/skkey.jpg" alt="post" width="500"/>-5. Create workflows on the workflow platform (or import templates from workflow folder)-6. Use skkey for content publishing in workflow parameter settings- <img src="./workflow/img/fl.jpg" alt="post" width="500"/>--## Workflow Platform Interface-aitoearn-channel\src\core\mcp\plugin.controller.ts\ No newline at end of file+## Contribution Guide++Please see [Contribution Guide](CONTRIBUTING_EN.md) for information on how to contribute to the project development.++## Contact Us++If you have any questions, please contact us through the following ways:++- Submit GitHub Issues+- Send email to [[email protected]](mailto:[email protected])\ No newline at end of file