[improve][doc]修改readme格式

This commit is contained in:
祝安祥
2025-09-23 14:54:21 +08:00
parent cce0fe564d
commit 635eb1f565

View File

@@ -15,15 +15,15 @@
- **Docker 一键部署**: 提供 `docker-compose` 配置,实现快速、标准化的容器化部署。
- **健壮的反爬策略**: 模拟真人操作,包含多种随机延迟和用户行为,提高稳定性。
## 页面截图
## 🖼 页面截图
**后台任务管理**
### 后台任务管理
![img.png](static/img.png)
**后台监控截图**
### 后台监控截图
![img_1.png](static/img_1.png)
**ntf通知截图**
### ntfy通知截图
![img_2.png](static/img_2.png)
## 🚀 快速开始 (Web UI 推荐)
@@ -66,7 +66,7 @@ pip install -r requirements.txt
`.env` 文件中的所有可用配置项如下:
| 环境变量 | 说明 | 是否必填 | 注意事项 |
| :--- | :--- | :--- | :--- |
| :--- | :--- | :---: | :--- |
| `OPENAI_API_KEY` | 你的AI模型服务商提供的API Key。 | 是 | 对于某些本地或特定代理的服务,此项可能为可选。 |
| `OPENAI_BASE_URL` | AI模型的API接口地址必须兼容OpenAI格式。 | 是 | 请填写API的基础路径例如 `https://ark.cn-beijing.volces.com/api/v3/`。 |
| `OPENAI_MODEL_NAME` | 你要使用的具体模型名称。 | 是 | **必须**选择一个支持图片分析的多模态模型,如 `doubao-seed-1-6-250615`, `gemini-2.5-pro` 等。 |
@@ -99,6 +99,7 @@ pip install -r requirements.txt
2. **获取登录状态 (重要!)**: 为了让爬虫能够以登录状态访问闲鱼必须先提供有效的登录凭证。我们推荐使用Web UI来完成此操作
**推荐方式:通过 Web UI 更新**
1. 先跳过此步骤直接执行第3步启动Web服务。
2. 打开Web UI后进入 **"系统设置"** 页面。
3. 找到 "登录状态文件",点击 **"手动更新"** 按钮。
@@ -113,6 +114,7 @@ pip install -r requirements.txt
这种方式无需在服务器上运行带图形界面的程序,最为便捷。
**备用方式:运行登录脚本**
如果您可以在本地或带桌面的服务器上运行程序,也可以使用传统的脚本方式:
```bash
@@ -133,8 +135,8 @@ python web_server.py
在浏览器中打开 `http://127.0.0.1:8000` 访问管理后台。
1. 在 **任务管理** 页面,点击 **创建新任务**。
2. 在弹出的窗口中,用自然语言描述你的购买需求(例如:我想买一台95新以上的索尼A7M4相机预算1万3以内快门数低于5000),并填写任务名称、关键词等信息。
1. 在 **"任务管理"** 页面,点击 **"创建新任务"**。
2. 在弹出的窗口中,用自然语言描述你的购买需求(例如:"我想买一台95新以上的索尼A7M4相机预算1万3以内快门数低于5000"),并填写任务名称、关键词等信息。
3. 点击创建AI将自动为你生成一套复杂的分析标准。
4. 回到主界面,为任务添加定时或直接点击启动,开始自动化监控!
@@ -156,6 +158,7 @@ python web_server.py
3. **创建 `.env` 文件**: 参考 **[快速开始](#-快速开始-web-ui-推荐)** 部分的说明,在项目根目录创建并填写 `.env` 文件。
4. **获取登录状态 (关键步骤!)**: Docker容器内无法进行扫码登录。请在**启动容器后**通过访问Web UI来设置登录状态
1. (在宿主机上)执行 `docker-compose up -d` 启动服务。
2. 在浏览器中打开 `http://127.0.0.1:8000` 访问Web UI。
3. 进入 **"系统设置"** 页面,点击 **"手动更新"** 按钮。
@@ -187,7 +190,7 @@ docker-compose up --build -d
### 第 3 步: 访问和管理
- **访问 Web UI**: 在浏览器中打开 `http://127.0.0.1:8000`
- **访问 Web UI**: 在浏览器中打开 `http://127.0.0.1:8000`
- **查看实时日志**: `docker-compose logs -f`
- **停止容器**: `docker-compose stop`
- **启动已停止的容器**: `docker-compose start`
@@ -195,20 +198,27 @@ docker-compose up --build -d
## 📸 Web UI 功能一览
- **任务管理**:
- **AI创建任务**: 使用自然语言描述需求一键生成监控任务和配套AI分析标准。
- **可视化编辑与控制**: 在表格中直接修改任务参数(如关键词、价格、定时规则等),并能独立启/停、删除每个任务
- **定时调度**: 为任务配置 Cron 表达式,实现自动化周期性运行
- **结果查看**:
- **卡片式浏览**: 以图文卡片形式清晰展示每个符合条件的商品。
- **智能筛选与排序**: 可一键筛选出所有被AI标记为“推荐”的商品并支持按爬取时间、发布时间、价格等多种方式排序。
- **深度详情**: 点击即可查看每个商品的完整抓取数据和AI分析的详细JSON结果。
- **运行日志**:
- **实时日志流**: 在网页上实时查看爬虫运行的详细日志,方便追踪进度和排查问题
- **日志管理**: 支持自动刷新、手动刷新和一键清空日志
- **系统设置**:
- **状态检查**: 一键检查 `.env` 配置、登录状态等关键依赖是否正常。
- **Prompt在线编辑**: 直接在网页上编辑和保存用于AI分析的 `prompt` 文件实时调整AI的思考逻辑。
### 任务管理
- **AI创建任务**: 使用自然语言描述需求一键生成监控任务和配套AI分析标准
- **可视化编辑与控制**: 在表格中直接修改任务参数(如关键词、价格、定时规则等),并能独立启/停、删除每个任务
- **定时调度**: 为任务配置 Cron 表达式,实现自动化周期性运行。
### 结果查看
- **卡片式浏览**: 以图文卡片形式清晰展示每个符合条件的商品。
- **智能筛选与排序**: 可一键筛选出所有被AI标记为"推荐"的商品,并支持按爬取时间、发布时间、价格等多种方式排序
- **深度详情**: 点击即可查看每个商品的完整抓取数据和AI分析的详细JSON结果
### 运行日志
- **实时日志流**: 在网页上实时查看爬虫运行的详细日志,方便追踪进度和排查问题。
- **日志管理**: 支持自动刷新、手动刷新和一键清空日志。
### 系统设置
- **状态检查**: 一键检查 `.env` 配置、登录状态等关键依赖是否正常。
- **Prompt在线编辑**: 直接在网页上编辑和保存用于AI分析的 `prompt` 文件实时调整AI的思考逻辑。
## 🚀 工作流程
@@ -249,6 +259,7 @@ WEB_PASSWORD=admin123
#### 默认凭据
如果未在 `.env` 文件中设置认证凭据,系统将使用以下默认值:
- 用户名:`admin`
- 密码:`admin123`
@@ -274,13 +285,13 @@ WEB_PASSWORD=admin123
详细配置说明请参考 [AUTH_README.md](AUTH_README.md)。
## 常见问题 (FAQ)
## 常见问题 (FAQ)
我们整理了一份详细的常见问题解答文档覆盖了从环境配置、AI设置到反爬虫策略的各类问题。
👉 **[点击此处查看常见问题解答 (FAQ.md)](FAQ.md)**
## 致谢
## 🙏 致谢
本项目在开发过程中参考了以下优秀项目,特此感谢:
@@ -294,7 +305,8 @@ WEB_PASSWORD=admin123
以及感谢 ClaudeCode/ModelScope/Gemini 等模型/工具,解放双手 体验Vibe Coding的快乐。
## 体会
## 💭 体会
本项目 90%+ 的代码都由AI生成包括 ISSUE 中涉及的 PR 。
Vibe Coding 的可怕之处在于如果不过多的参与项目建设对AI生成的代码没有进行细致的review没有思考过AI为什么这么写盲目的通过跑测试用例验证功能可用性只会导致项目变成一个黑盒。