Skip to content

Let's use AI to Earn!

feat: 文档

Nevin8a37f03444a1
diff --git a/aitoearn_web/README.md b/aitoearn_web/README.md
index 2038604b..ec47fe1f 100644
--- a/aitoearn_web/README.md
+++ b/aitoearn_web/README.md
@@ -10,19 +10,58 @@
## 项目介绍
-AiToEarn的WEB项目,web端实现: 抖音,B站,快手,YouTube, Twitter,TikTok,Facebook,微信公众号,Instagram,Threads,Pinterest 11个平台的矩阵发布
+AiToEarn的WEB项目,web端实现: Twitter,TikTok,Facebook,Instagram,Threads,Pinterest
+![抖音](https://lf1-cdn-tos.bytegoofy.com/goofy/ies/douyin_web/public/favicon.ico '抖音') 抖音
+![B站](https://i0.hdslb.com/bfs/static/jinkela/long/images/favicon.ico 'B站') B站
+![快手](https://s1-111422.kwimgs.com/kos/nlav111422/ks-web/favicon.ico '快手') 快手
+![微信公众号](https://res.wx.qq.com/a/wx_fed/assets/res/NTI4MWU5.ico '微信公众号') 微信公众号
+![YouTube](https://ts1.tc.mm.bing.net/th/id/ODF.cUjlg4bwA5-JhXB6Kg6qZA?w=32&h=32&qlt=70&pcl=fffffa&o=7&cb=thws4&pid=1.2&rm=3 'YouTube') YouTube
+11个平台的矩阵发布
-## 后端模块介绍
+## 后端模块
1. `aitoearn-gateway` - 网关模块
+```tree
+├── config 不同环境的配置文件
+│
+├── src
+│ ├── auth 认证模块
+│ ├── common 公共模块
+│ ├── core 主进程源码
+│ │ ├── file 文件模块
+│ │ ├── plat 三方平台模块
+│ │ └── ... 其他
+│ ├── libs 工具模块
+│ ├── transports 通信模块
+│ └── views 视图
+```
2. `aitoearn-channel` - 渠道模块
+```tree
+├── config 不同环境的配置文件
+│
+├── src
+│ ├── common 公共模块
+│ ├── core 主进程源码
+│ │ ├── account 三方平台账号模块
+│ │ ├── dataCube 三方平台数据统计模块
+│ │ ├── file 文件模块
+│ │ ├── interact 互动模块
+│ │ ├── mcp MCP服务用模块
+│ │ ├── plat 三方平台模块
+│ │ ├── publish 发布模块
+│ │ ├── skKey skKey模块
+│ │ └── ... 其他
+│ ├── libs 工具模块
+│ ├── transports 通信模块
+│ └── views
+```
3. `aitoearn-user` - 用户模块
4. `aitoearn-wxplat` - 微信三方平台服务(解耦开发环境)
## 后端技术栈
-- NestJS
-- NATS
+- NestJS nodejs 框架
+- NATS 消息队列
- MongoDB
- Redis
- AWS S3
@@ -30,15 +69,26 @@ AiToEarn的WEB项目,web端实现: 抖音,B站,快手,YouTube, Twitter
## 使用方法
-1. 启动后端服务模块:
- - `aitoearn-gateway`
- - `aitoearn-channel`
- - `aitoearn-user`
- - `aitoearn-wxplat`
+1. 分别启动后端服务模块:
+ 本地启动:config目录下创建local.config.js文件(复制dev.config.js文件修改配置)
+ ```sh
+ pnpm i
+ pnpm run dev:local
+ ```
2. 启动前端项目:`aitoearn-web`
-3. 在前端页面进行账号授权,并创建 `skkey`
+ ```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` 进行内容发布
+5. 在工作流的参数设置使用 `skkey` 进行内容发布
+<img src="./workflow/img/fl.jpg" alt="post" width="500"/>
## 工作流平台使用的接口
diff --git a/aitoearn_web/README_EN.md b/aitoearn_web/README_EN.md
index b0388c7c..06283d63 100644
--- a/aitoearn_web/README_EN.md
+++ b/aitoearn_web/README_EN.md
@@ -10,36 +10,79 @@
## Project Introduction
-AiToEarn WEB project implements matrix publishing across 11 platforms on the web side: Douyin, Bilibili, Kuaishou, YouTube, Twitter, TikTok, Facebook, WeChat Official Accounts, Instagram, Threads, and Pinterest.
+AiToEarn WEB project implements matrix publishing across 11 platforms on the web side: Twitter, TikTok, Facebook, Instagram, Threads, Pinterest
+![Douyin](https://lf1-cdn-tos.bytegoofy.com/goofy/ies/douyin_web/public/favicon.ico 'Douyin') Douyin
+![Bilibili](https://i0.hdslb.com/bfs/static/jinkela/long/images/favicon.ico 'Bilibili') Bilibili
+![Kuaishou](https://s1-111422.kwimgs.com/kos/nlav111422/ks-web/favicon.ico 'Kuaishou') Kuaishou
+![WeChat Official Accounts](https://res.wx.qq.com/a/wx_fed/assets/res/NTI4MWU5.ico 'WeChat Official Accounts') WeChat Official Accounts
+![YouTube](https://ts1.tc.mm.bing.net/th/id/ODF.cUjlg4bwA5-JhXB6Kg6qZA?w=32&h=32&qlt=70&pcl=fffffa&o=7&cb=thws4&pid=1.2&rm=3 'YouTube') YouTube
+Matrix publishing across 11 platforms
-## Backend Modules Introduction
+## Backend Modules
1. `aitoearn-gateway` - Gateway module
-2. `aitoearn-channel` - Channel module
-3. `aitoearn-user` - User module
-4. `aitoearn-wxplat` - WeChat third-party platform service (decoupled development environment)
+```tree
+├── config Configuration files for different environments
+│
+├── src
+│ ├── auth Authentication module
+│ ├── common Common module
+│ ├── core Main process source code
+│ │ ├── file File module
+│ │ ├── plat Third-party platform module
+│ │ └── ... Others
+│ ├── libs Utility modules
+│ ├── transports Communication module
+│ └── views Views
+```
+2. aitoearn-channel - Channel module
+```tree
+├── config Configuration files for different environments
+│
+├── src
+│ ├── common Common module
+│ ├── core Main process source code
+│ │ ├── account Third-party platform account module
+│ │ ├── dataCube Third-party platform data statistics module
+│ │ ├── file File module
+│ │ ├── interact Interaction module
+│ │ ├── mcp MCP service module
+│ │ ├── plat Third-party platform module
+│ │ ├── publish Publishing module
+│ │ ├── skKey skKey module
+│ │ └── ... Others
+│ ├── libs Utility modules
+│ ├── transports Communication module
+│ └── views
+```
+3. aitoearn-user - User module
+4. aitoearn-wxplat - WeChat third-party platform service (decoupled development environment)
## Backend Technology Stack
-
-- NestJS
-- NATS
-- MongoDB
-- Redis
-- AWS S3
-- BullMQ
-
+NestJS Node.js framework
+NATS Message queue
+MongoDB
+Redis
+AWS S3
+BullMQ
## Usage Instructions
-
-1. Start backend service modules:
- - `aitoearn-gateway`
- - `aitoearn-channel`
- - `aitoearn-user`
- - `aitoearn-wxplat`
-2. Start frontend project: `aitoearn-web`
-3. Authorize accounts and create `skkey` on the frontend page
-4. Create workflows on the workflow platform (or import templates from the workflow folder)
-5. Use `skkey` for content publishing
+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
+pnpm run dev:local
+```
+2. Start frontend project: aitoearn-web
+```sh
+pnpm i
+pnpm 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
+aitoearn-channel\src\core\mcp\plugin.controller.ts
\ No newline at end of file
diff --git a/aitoearn_web/workflow/img/account.jpeg b/aitoearn_web/workflow/img/account.jpeg
new file mode 100644
index 00000000..5f70bdc9
Binary files /dev/null and b/aitoearn_web/workflow/img/account.jpeg differ
diff --git a/aitoearn_web/workflow/img/fl.jpeg b/aitoearn_web/workflow/img/fl.jpeg
new file mode 100644
index 00000000..feccd8e9
Binary files /dev/null and b/aitoearn_web/workflow/img/fl.jpeg differ
diff --git a/aitoearn_web/workflow/img/skkey.jpg b/aitoearn_web/workflow/img/skkey.jpg
new file mode 100644
index 00000000..0aaa7ea1
Binary files /dev/null and b/aitoearn_web/workflow/img/skkey.jpg differ