first commit
This commit is contained in:
120
README.md
Normal file
120
README.md
Normal file
@@ -0,0 +1,120 @@
|
||||
# 低代码智能体平台
|
||||
|
||||
一个支持可视化工作流设计和智能Agent配置的低代码平台。
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 前置要求
|
||||
|
||||
- Node.js 18+ 和 pnpm
|
||||
- Python 3.11+
|
||||
- Docker 和 Docker Compose
|
||||
- MySQL(使用腾讯云数据库)
|
||||
- Redis 7+(或使用Docker)
|
||||
|
||||
### 使用 Docker Compose 启动(推荐)
|
||||
|
||||
```bash
|
||||
# 启动所有服务
|
||||
docker-compose -f docker-compose.dev.yml up -d
|
||||
|
||||
# 查看日志
|
||||
docker-compose logs -f
|
||||
|
||||
# 停止服务
|
||||
docker-compose down
|
||||
```
|
||||
|
||||
### 本地开发
|
||||
|
||||
#### 前端开发
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
pnpm install
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
前端服务将在 http://localhost:8038 启动
|
||||
|
||||
#### 后端开发
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
|
||||
# 创建虚拟环境
|
||||
python -m venv venv
|
||||
source venv/bin/activate # Windows: venv\Scripts\activate
|
||||
|
||||
# 安装依赖
|
||||
pip install -r requirements.txt
|
||||
|
||||
# 配置环境变量
|
||||
cp env.example .env
|
||||
# 编辑 .env 文件(数据库已配置为腾讯云MySQL)
|
||||
|
||||
# 运行数据库迁移
|
||||
alembic upgrade head
|
||||
|
||||
# 启动开发服务器
|
||||
uvicorn app.main:app --reload
|
||||
|
||||
# 启动 Celery Worker(新终端)
|
||||
celery -A app.core.celery_app worker --loglevel=info
|
||||
```
|
||||
|
||||
后端服务将在 http://localhost:8037 启动
|
||||
|
||||
API文档:http://localhost:8037/docs
|
||||
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
aiagent/
|
||||
├── frontend/ # 前端项目(Vue 3 + TypeScript)
|
||||
├── backend/ # 后端项目(Python FastAPI)
|
||||
├── docker-compose.dev.yml # 开发环境Docker配置
|
||||
└── README.md # 项目说明
|
||||
```
|
||||
|
||||
## 🛠️ 技术栈
|
||||
|
||||
### 前端
|
||||
- Vue 3 + TypeScript + Vite
|
||||
- Pinia(状态管理)
|
||||
- Element Plus(UI组件)
|
||||
- Vue Flow(工作流可视化)
|
||||
|
||||
### 后端
|
||||
- Python FastAPI
|
||||
- MySQL(腾讯云数据库)
|
||||
- Redis(缓存和消息队列)
|
||||
- Celery(异步任务)
|
||||
- LangChain(Agent框架)
|
||||
|
||||
## 📚 文档
|
||||
|
||||
详细技术方案请参考:[方案-优化版.md](./方案-优化版.md)
|
||||
|
||||
## 📝 开发规范
|
||||
|
||||
- 前端代码规范:ESLint + Prettier
|
||||
- 后端代码规范:PEP 8 + Black
|
||||
- Git提交规范:Conventional Commits
|
||||
- 代码审查:必须通过Code Review
|
||||
|
||||
## 🧪 测试
|
||||
|
||||
```bash
|
||||
# 前端测试
|
||||
cd frontend
|
||||
pnpm test
|
||||
|
||||
# 后端测试
|
||||
cd backend
|
||||
pytest
|
||||
```
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
MIT License
|
||||
Reference in New Issue
Block a user