Files
makemd/README.md
wurenzhi 15ee1758f5 refactor: 重构项目结构并优化类型定义
- 移除extension模块,将功能迁移至node-agent
- 修复类型导出问题,使用export type明确类型导出
- 统一数据库连接方式,从直接导入改为使用config/database
- 更新文档中的项目结构描述
- 添加多个服务的实用方法,如getForecast、getBalances等
- 修复类型错误和TS1205警告
- 优化RedisService调用方式
- 添加新的实体类型定义
- 更新审计日志格式,统一字段命名
2026-03-21 15:04:06 +08:00

144 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Crawlful Hub
## 📋 项目简介
Crawlful Hub 是一个全自动化的跨境电商运营平台集成了商品管理、订单处理、物流策略、广告营销、B2B贸易等核心功能通过AI技术实现智能决策和自动化运营。
## 🚀 核心功能
### 1. 商品管理
- 商品刊登与管理
- 库存同步与管理
- 商品健康度监控
### 2. 订单管理
- 多平台订单集中管理
- 订单履约与异常处理
- 批量订单处理
### 3. 物流策略
- 智能物流渠道选择
- 运费计算与优化
- 物流轨迹跟踪
### 4. 广告营销
- 广告计划创建与管理
- 投放效果分析
- ROI优化
### 5. B2B贸易
- 企业报价管理
- 批量订单处理
- 合同管理
### 6. 售后逆向
- 退货申请处理
- 退款流程管理
- 客户服务
### 7. 合规与证书管理
- 证书管理与过期提醒
- 合规检查
### 8. 用户资产
- 资产概览
- 积分管理
- 会员等级
### 9. A/B测试与策略优化
- 测试策略推荐
- 自动优化算法
## 🏗 项目架构
### 技术栈
- **前端**: React, TypeScript, UmiJS, Tailwind CSS
- **后端**: Node.js, Express, TypeScript
- **数据库**: MySQL
- **缓存**: Redis
- **消息队列**: BullMQ
- **AI**: 集成多种AI服务
### 模块结构
- **dashboard**: 前端管理控制台
- **server**: 后端服务
- **node-agent**: 节点代理 (Playwright 自动化)
- **scripts**: 脚本工具
- **docs**: 项目文档
## 📦 快速开始
### 环境要求
- Node.js 16+
- MySQL 8.0+
- Redis 6.0+
### 安装依赖
```bash
# 后端依赖
cd server
npm install
# 前端依赖
cd ../dashboard
npm install
# Node Agent 依赖
cd ../node-agent
npm install
```
### 数据库初始化
```bash
# 执行数据库初始化脚本
mysql -u root -p < scripts/db-init.sql
```
### 启动服务
```bash
# 启动后端服务
cd server
npm run dev
# 启动前端服务
cd ../dashboard
npm run dev
# 启动 Node Agent
cd ../node-agent
npm run dev
```
## 📚 文档
- **业务蓝图**: `docs/00_Business/`
- **架构设计**: `docs/01_Architecture/`
- **后端文档**: `docs/02_Backend/`
- **前端文档**: `docs/03_Frontend/`
- **插件文档**: `docs/04_Plugin/`
- **AI策略**: `docs/05_AI/`
- **测试文档**: `docs/07_Testing/`
## 🔧 开发规范
### 代码规范
- 遵循 TypeScript 最佳实践
- 使用 ESLint 进行代码检查
- 提交代码前运行 `npm run check` 进行类型检查
### 提交规范
- 提交信息使用中文描述
- 提交前确保代码通过测试
- 大型功能提交前创建分支
## 🤝 贡献
欢迎贡献代码和提出建议!请先阅读项目文档,然后提交 Pull Request。
## 📄 许可证
MIT License