Skip to content

Commit 737e646

Browse files
committed
docs: update NavigatorAI readme
1 parent bb070df commit 737e646

File tree

1 file changed

+122
-2
lines changed

1 file changed

+122
-2
lines changed
Lines changed: 122 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,123 @@
1-
NavigatorAI
2-
maintained by [Tsumugii24](https://github.com/Tsumugii24)
1+
# NavigatorAI
2+
3+
> 一个基于多智能体框架的智能旅行规划助手,可与用户进行对话生成精美的旅游出行方案,此外可以识别用户在PDF上的标注修改并自动优化旅行方案
4+
5+
[Tsumugii24](https://github.com/Tsumugii24) 开发维护
6+
7+
## 项目介绍
8+
9+
NavigatorAI 是一个基于多智能体框架搭建的智能旅行规划助手,能够理解用户对现有旅行计划的反馈和标注,并据此自动调整和优化旅行方案。用户可以在PDF文档上进行批注、画圈或添加文字等方式提出修改建议,系统能够智能识别并生成更新后的旅行计划。
10+
11+
## 功能特点
12+
13+
- 📝 识别PDF上的用户批注和反馈
14+
- 🔄 根据反馈自动调整旅行计划内容
15+
- 📊 生成美观的HTML格式旅行方案
16+
- 📄 支持PDF文件的上传和预览
17+
- 💬 交互式反馈修改流程
18+
- 🌐 前后端分离架构
19+
20+
## 技术栈
21+
22+
### 前端
23+
- Next.js 14
24+
- React 18
25+
- TailwindCSS
26+
- Radix UI 组件库
27+
28+
### 后端
29+
- Python 3.10+
30+
- Flask 3.0.3
31+
- OpenAI API (使用 GPT-4o 等多模态能力的大语言模型)
32+
- Qwen API (调用Qwen2.5-72B-Instruct)
33+
- PDF处理工具链
34+
35+
## 快速开始
36+
37+
### 环境准备
38+
39+
1. 确保已安装 Node.js (18+) 和 Python 3.10+
40+
2. 克隆项目仓库
41+
42+
### 后端设置
43+
44+
1. 进入后端目录
45+
```bash
46+
cd backend
47+
```
48+
49+
2. 安装依赖
50+
```bash
51+
pip install -r requirements.txt
52+
```
53+
54+
3. 创建环境变量文件
55+
```bash
56+
cp .env.example .env
57+
```
58+
59+
4.`.env` 文件中填入必要配置,包括 OpenAI API KEY, OPENAI BASE URL, QWEN API KEY
60+
61+
5. 启动后端服务
62+
```bash
63+
python app.py
64+
```
65+
66+
### 前端设置
67+
68+
1. 进入前端目录
69+
```bash
70+
cd frontend
71+
```
72+
73+
2. 安装依赖
74+
```bash
75+
npm install
76+
```
77+
78+
3. 创建环境变量文件
79+
```bash
80+
cp .env.example .env
81+
```
82+
83+
4. 启动开发服务器
84+
```bash
85+
npm run dev
86+
```
87+
88+
## 使用流程
89+
90+
1. 在前端界面上传旅行计划的 PDF 文件
91+
2. 查看并确认上传的文件
92+
3. 在提示框中输入您希望对旅行计划进行的修改建议
93+
4. 系统会分析您的反馈并生成修改后的方案
94+
5. 您可以下载更新后的 PDF 文件或继续提供新的反馈
95+
96+
## 项目核心结构
97+
98+
```
99+
NavigatorAI/
100+
├── frontend/ # 前端目录
101+
│ ├── app/ # Next.js 应用程序
102+
│ ├── components/ # React 组件
103+
│ ├── styles/ # 样式文件
104+
│ └── public/ # 静态资源和上传的文件
105+
106+
├── backend/ # 后端目录
107+
│ ├── app.py # Flask 应用入口
108+
│ ├── main.py # 主要业务逻辑
109+
│ ├── pdf2image.py # PDF处理工具
110+
│ └── html2pdf.py # HTML转PDF工具
111+
```
112+
113+
## 贡献指南
114+
115+
欢迎提交问题报告、功能请求的issue或直接提交 Pull Requests 来改进项目。
116+
117+
## 许可证
118+
119+
**特别注意**:NavigatorAI遵循[CC BY-NC](https://creativecommons.org/licenses/by-nc/4.0/)协议,仅供学习使用,不能商用!!!
120+
121+
---
122+
3123
正在持续迭代中,欢迎反馈问题

0 commit comments

Comments
 (0)