1 line
14 KiB
JSON
1 line
14 KiB
JSON
{"repo": "calderbuild/vibedoc", "files": {"DEPLOYMENT.md": {"19bd95ed22f7dc927e443dc7d7d1f8058708664c": {"t": 1785674114.4173772, "n": 4954, "h": "2149239610da7224", "c": "# 🚀 VibeDoc 部署指南\r\n\r\n## 📋 目录\r\n- [快速部署](#快速部署)\r\n- [魔塔ModelScope部署](#魔塔modelscope部署)\r\n- [Docker部署](#docker部署)\r\n- [本地开发](#本地开发)\r\n- [环境配置](#环境配置)\r\n- [故障排除](#故障排除)\r\n\r\n## 🚀 快速部署\r\n\r\n### 方法1：魔塔ModelScope一键部署（推荐）\r\n\r\n1. **登录魔塔ModelScope**\r\n - 访问 [ModelScope](https://modelscope.cn)\r\n - 注册并登录账户\r\n\r\n2. **导入项目**\r\n ```\r\n 仓库地址: https://github.com/JasonRobertDestiny/VibeDocs.git\r\n 分支: modelscope\r\n SDK: Gradio\r\n ```\r\n\r\n3. **配置环境变量**\r\n ```bash\r\n SILICONFLOW_API_KEY=your_api_key_here\r\n NODE_ENV=production\r\n PORT=3000\r\n ```\r\n\r\n4. **启动部署**\r\n - 点击\"启动\"按钮\r\n - 等待构建完成\r\n\r\n### 方法2：本地快速启动\r\n\r\n```bash\r\n# 克隆项目\r\ngit clone https://github.com/JasonRobertDestiny/VibeDocs.git\r\ncd VibeDocs\r\n\r\n# 切换到正确分支\r\ngit checkout modelscope\r\n\r\n# 安装依赖\r\npip install -r requirements.txt\r\n\r\n# 配置环境变量\r\ncp .env.example .env\r\n# 编辑 .env 文件，添加你的API密钥\r\n\r\n# 启动应用\r\npython app.py\r\n```\r\n\r\n## 🌟 魔塔ModelScope部署\r\n\r\n### 完整部署配置\r\n\r\n**项目信息：**\r\n- **仓库地址：** `https://github.com/JasonRobertDestiny/VibeDocs.git`\r\n- **分支：** `modelscope`\r\n- **SDK：** `Gradio`\r\n- **Python版本：** `3.11`\r\n\r\n**环境变量配置：**\r\n\r\n| 变量名 | 值 | 说明 | 必填 |\r\n|--------|----|----|------|\r\n| `SILICONFLOW_API_KEY` | `your_api_key` | Silicon Flow API密钥 | ✅ |\r\n| `NODE_ENV` | `production` | 运行环境 | ✅ |\r\n| `PORT` | `3000` | 应用端口 | ✅ |\r\n| `DEEPWIKI_SSE_URL` | `http://localhost:8080` | DeepWiki MCP服务 | ❌ |\r\n| `FETCH_SSE_URL` | `http://localhost:8081` | 通用抓取MCP服务 | ❌ |\r\n| `DOUBAO_SSE_URL` | `http://localhost:8082` | 图像生成MCP服务 | ❌ |\r\n| `DOUBAO_API_KEY` | `your_doubao_key` | Doubao API密钥 | ❌ |\r\n\r\n### 部署步骤详解\r\n\r\n1. **准备API密钥**\r\n - 访问 [Silicon Flow](https://siliconflow.cn) 注册账户\r\n - 获取免费API密钥\r\n\r\n2. **创建创空间**\r\n - 在ModelScope中创建新的创空间\r\n - 选择\"从Git仓库导入\"\r\n\r\n3. **配置项目设置**\r\n ```yaml\r\n title: \"VibeDoc AI Agent - Agent应用开发赛道\"\r\n emoji: \"🤖\"\r\n sdk: gradio\r\n sdk_version: 5.34.1\r\n app_file: app.py\r\n ```\r\n\r\n4. **设置环境变量**\r\n - 在创空间设置中添加环境变量\r\n - 确保 `SILICONFLOW_API_KEY` 正确配置\r\n\r\n5. **构建和部署**\r\n - 点击\"构建\"按钮\r\n - 等待构建完成\r\n - 测试应用功能\r\n\r\n### 常见问题解决\r\n\r\n**问题1：构建失败**\r\n- 确保使用 `modelscope` 分支\r\n- 检查 `requirements.txt` 文件是否存在\r\n- 验证Python版本兼容性\r\n\r\n**问题2：API调用失败**\r\n- 检查 `SILICONFLOW_API_KEY` 是否正确\r\n- 验证API密钥是否有效\r\n- 确认网络连接正常\r\n\r\n**问题3：MCP服务不可用**\r\n- MCP服务是可选的，不影响核心功能\r\n- 如果不使用外部链接解析，可以忽略相关错误\r\n\r\n## 🐳 Docker部署\r\n\r\n### 使用Docker Compose（推荐）\r\n\r\n```bash\r\n# 克隆项目\r\ngit clone https://github.com/JasonRobertDestiny/VibeDocs.git\r\ncd VibeDocs\r\n\r\n# 配置环境变量\r\ncp .env.example .env\r\n# 编辑 .env 文件\r\n\r\n# 启动服务\r\ndocker-compose up -d\r\n\r\n# 查看日志\r\ndocker-compose logs -f vibedoc\r\n```\r\n\r\n### 使用Docker直接构建\r\n\r\n```bash\r\n# 构建镜像\r\ndocker build -t vibedoc .\r\n\r\n# 运行容器\r\ndocker run -d \\\r\n --name vibedoc \\\r\n -p 3000:3000 \\\r\n -e SILICONFLOW_API_KEY=your_api_key \\\r\n -e NODE_ENV=production \\\r\n vibedoc\r\n```\r\n\r\n## 💻 本地开发\r\n\r\n### 环境要求\r\n- Python 3.11+\r\n- pip 或 pipenv\r\n- Git\r\n\r\n### 开发环境设置\r\n\r\n```bash\r\n# 1. 克隆项目\r\ngit clone https://github.com/JasonRobertDestiny/VibeDocs.git\r\ncd VibeDocs\r\n\r\n# 2. 创建虚拟环境（可选）\r\npython -m venv venv\r\nsource venv/bin/activate # Windows: venv\\Scripts\\activate\r\n\r\n# 3. 安装依赖\r\npip install -r requirements.txt\r\n\r\n# 4. 配置环境变量\r\ncp .env.example .env\r\n# 编辑 .env 文件，添加必要的配置\r\n\r\n# 5. 启动开发服务器\r\npython app.py\r\n```\r\n\r\n### 开发工具推荐\r\n\r\n- **IDE：** VS Code, PyCharm\r\n- **Python插件：** Python Extension Pack\r\n- **代码格式化：** Black, isort\r\n- **类型检查：** mypy\r\n- **测试框架：** pytest\r\n\r\n## ⚙️ 环境配置\r\n\r\n### 必填配置\r\n\r\n```bash\r\n# Silicon Flow API密钥（必填）\r\nSILICONFLOW_API_KEY=your_siliconflow_api_key\r\n\r\n# 应用配置\r\nNODE_ENV=production\r\nPORT=3000\r\n```\r\n\r\n### 可选配置\r\n\r\n```bash\r\n# MCP服务配置（可选）\r\nDEEPWIKI_SSE_URL=http://localhost:8080\r\nFETCH_SSE_URL=http://localhost:8081\r\nDOUBAO_SSE_URL=http://localhost:8082\r\nDOUBAO_API_KEY=your_doubao_api_key\r\n\r\n# 调试配置\r\nDEBUG=false\r\nLOG_LEVEL=INFO\r\nAPI_TIMEOUT=120\r\nMCP_TIMEOUT=30\r\n```\r\n\r\n### 配置文件说明\r\n\r\n- `.env.example`: 环境变量模板\r\n- `app_config.yaml`: 魔塔部署配置\r\n- `requirements.txt`: Python依赖\r\n- `Dockerfile`: Docker镜像配置\r\n- `docker-compose.yml`: 容器编排配置\r\n\r\n## 🛠️ 故障排除\r\n\r\n### 常见错误及解决方案\r\n\r\n**错误1：`ModuleNotFoundError`**\r\n```bash\r\n# 解决方案：重新安装依赖\r\npip install -r requirements.txt\r\n```\r\n\r\n**错误2：API密钥错误**\r\n```bash\r\n# 检查环境变量\r\necho $SILICONFLOW_API_KEY\r\n\r\n# 验证密钥格式\r\n# 应该以 \"sk-\" 开头\r\n```\r\n\r\n**错误3：端口占用**\r\n```bash\r\n# 查找占用端口的进程\r\nlsof -i :3000\r\n\r\n# 杀死进程\r\nkill -9 <PID>\r\n\r\n# 或者更改端口\r\nexport PORT=3001\r\n```\r\n\r\n**错误4：网络连接问题**\r\n```bash\r\n# 测试网络连接\r\ncurl -I https://api.siliconflow.cn/v1/chat/completions\r\n\r\n# 检查防火墙设置\r\n# 确保端口3000可以访问\r\n```\r\n\r\n### 日志调试\r\n\r\n```bash\r\n# 查看应用日志\r\ntail -f /var/log/vibedoc.log\r\n\r\n# Docker日志\r\ndocker logs vibedoc\r\n\r\n# 实时日志\r\ndocker logs -f vibedoc\r\n```\r\n\r\n### 性能优化\r\n\r\n1. **内存优化**\r\n - 增加容器内存限制\r\n - 使用更高效的Python版本\r\n\r\n2. **网络优化**\r\n - 配置CDN加速\r\n - 使用负载均衡\r\n\r\n3. **缓存优化**\r\n - 启用Redis缓存\r\n - 配置HTTP缓存头\r\n\r\n## 📞 技术支持\r\n\r\n如果遇到问题，请：\r\n\r\n1. 检查本文档的故障排除部分\r\n2. 查看项目Issues页面\r\n3. 提交新的Issue并提供：\r\n - 错误信息\r\n - 系统环境\r\n - 配置信息\r\n - 复现步骤\r\n\r\n## 🔄 更新升级\r\n\r\n```bash\r\n# 拉取最新代码\r\ngit pull origin modelscope\r\n\r\n# 更新依赖\r\npip install -r requirements.txt --upgrade\r\n\r\n# 重启应用\r\ndocker-compose restart vibedoc\r\n```\r\n\r\n---\r\n\r\n**🎯 提示：** 建议优先使用魔塔ModelScope部署，这是最简单且稳定的方式。本地开发时使用Docker可以确保环境一致性。"}}, ".claude/settings.local.json": {"19bd95ed22f7dc927e443dc7d7d1f8058708664c": {"t": 1785674124.3461246, "n": 5789, "h": "4a5917a4f554c67c", "c": "{\n \"permissions\": {\n \"allow\": [\n \"Bash(python -m py_compile /mnt/d/Fixed_program/Vibedocs/enhanced_mcp_client.py)\",\n \"Bash(python -c \\\"from app import fetch_knowledge_from_url_via_mcp, get_mcp_status_display; print(''✅ 主要功能导入成功'')\\\")\",\n \"Bash(python -c \\\"\\ntry:\\n from enhanced_mcp_client import call_fetch_mcp_async, call_deepwiki_mcp_async\\n print(''✅ enhanced_mcp_client 导入成功'')\\nexcept ImportError as e:\\n print(f''❌ enhanced_mcp_client 导入失败: {e}'')\\n\\ntry:\\n import gradio as gr\\n print(''✅ gradio 导入成功'')\\nexcept ImportError as e:\\n print(f''❌ gradio 导入失败: {e}'')\\n\\nprint(''🎉 核心MCP功能已就绪'')\\n\\\")\",\n \"Bash(pip install markdown python-docx reportlab html2text)\",\n \"Bash(python3 -m venv venv)\",\n \"Bash(source venv/bin/activate)\",\n \"Bash(pip install -r requirements.txt)\",\n \"Bash(python -c \\\"import gradio, markdown; print(''✅ 核心依赖已安装'')\\\")\",\n \"Bash(pip install gradio markdown requests)\",\n \"Bash(pip install --user gradio requests)\",\n \"Bash(python startup_test.py)\",\n \"Bash(python -c \\\"import gradio; print(''Gradio version:'', gradio.__version__)\\\")\",\n \"Bash(pip install --break-system-packages markdown python-docx)\",\n \"Bash(export SILICONFLOW_API_KEY=sk-fxeehbzkospkgoluchoqgxgkszkjaluozkohofghkzrqianx)\",\n \"Bash(pip install --break-system-packages html2text reportlab)\",\n \"Bash(git add .)\",\n \"Bash(git commit -m \\\"$(cat <<''EOF''\\n🚀 更新前端时间显示和ModelScope部署配置\\n\\n- 更新创意优化时间：~180秒 → 20秒\\n- 更新方案生成时间：60-100秒 → 60-180秒 \\n- 添加ModelScope frontmatter配置到README.md\\n- 创建.modelscope部署配置文件\\n- 优化MCP&Agent挑战赛部署准备\\n\\n🤖 Generated with [Claude Code](https://claude.ai/code)\\n\\nCo-Authored-By: Claude <noreply@anthropic.com>\\nEOF\\n)\\\")\",\n \"Bash(git push origin master)\",\n \"Bash(git commit -m \\\"删除不必要的.modelscope配置文件\\n\\n- 移除.modelscope文件，使用README.md frontmatter配置\\n- 简化部署配置，ModelScope会自动识别README.md设置\\n\\n🤖 Generated with [Claude Code](https://claude.ai/code)\\n\\nCo-Authored-By: Claude <noreply@anthropic.com>\\\")\",\n \"Bash(git config --list)\",\n \"Bash(git config user.email \\\"johnrobertdestiny@gmail.com\\\")\",\n \"Bash(git config --global user.email \\\"johnrobertdestiny@gmail.com\\\")\",\n \"Bash(git commit -m \\\"🚀 Transform to genuine open-source project\\n\\nMajor Changes:\\n- ✨ Remove all challenge-related content\\n- 📝 Create English README.md as main documentation \\n- 🌐 Add Chinese README.zh.md for Chinese users\\n- 🎯 Optimize project positioning as AI development tool\\n- 📖 Add comprehensive CLAUDE.md for developers\\n- 🗑️ Clean up challenge submission documents\\n- 🖼️ Add project screenshots and examples\\n- 📄 Add GitHub issue submission template\\n\\nFocus: Genuine open-source product for real user needs\\n\\n🤖 Generated with Claude Code (https://claude.ai/code)\\n\\nCo-Authored-By: Claude <noreply@anthropic.com>\\\")\",\n \"Bash(python3 -m py_compile /mnt/d/Fixed_program/Vibedocs/app.py)\",\n \"Bash(git checkout app.py)\",\n \"Bash(python3 -c \\\"from app import generate_development_plan; print(''✅ Import successful'')\\\")\",\n \"Bash(git commit -m \\\"Clean up repository and optimize READMEs\\n\\n- Remove unnecessary files (test files, submission docs, unused modules)\\n- Update README title: VibeDoc: Your AI Product Manager & Architect\\n- Create separate Chinese README.zh.md\\n- Remove plan_editor dependency (feature disabled)\\n- Keep only essential documentation files\\n- Optimize project structure for open source\\n\\n🤖 Generated with Claude Code (https://claude.ai/code)\\n\\nCo-Authored-By: Claude <noreply@anthropic.com>\\\")\",\n \"Bash(git commit -m \\\"Add comprehensive README with real example showcase\\n\\n- Recover HandVoice_Development_Plan.md as example\\n- Add detailed Real-World Example section to README\\n- Showcase complete generation output with diagrams\\n- Include actual AI coding prompt example\\n- Update title: VibeDoc: Your AI Product Manager & Architect\\n\\n🤖 Generated with Claude Code (https://claude.ai/code)\\n\\nCo-Authored-By: Claude <noreply@anthropic.com>\\\")\",\n \"Bash(git commit -m \\\"Update Chinese README with comprehensive showcase\\n\\n- Add Real-World Example section with HandVoice case\\n- Include detailed AI coding prompt example in Chinese\\n- Match English README structure and content\\n- Complete open-source project transformation\\n\\n🤖 Generated with Claude Code (https://claude.ai/code)\\n\\nCo-Authored-By: Claude <noreply@anthropic.com>\\\")\",\n \"Bash(python3 -c \\\"from app import generate_development_plan; print(''✅ App导入成功'')\\\")\",\n \"Bash(git commit -m \\\"Restore plan_editor.py - critical feature module\\n\\n- Recover plan_editor.py from previous commit\\n- Fix app.py import to include plan_editor\\n- Restore editing functionality\\n- All features now working correctly\\n\\n🤖 Generated with Claude Code (https://claude.ai/code)\\n\\nCo-Authored-By: Claude <noreply@anthropic.com>\\\")\",\n \"Bash(git add README.md README.zh.md)\",\n \"Bash(git commit -am \\\"Add online demo links to both READMEs\\n\\n- Add prominent online demo link at the top of both READMEs\\n- Create dedicated ''Online Demo (Recommended)'' section in Quick Start\\n- Include step-by-step usage guide for online demo\\n- Reorganize Quick Start with Online Demo and Local Installation sections\\n- Make online experience more discoverable for users\\n\\n🤖 Generated with Claude Code (https://claude.ai/code)\\n\\nCo-Authored-By: Claude <noreply@anthropic.com>\\\")\",\n \"Bash(echo \\\"✅ 在线体验链接已添加到两个README文件：\\n\\n📍 添加位置：\\n1. 顶部导航栏 - 🌐 Online Demo / 在线体验（最显眼位置）\\n2. Quick Start章节 - 专门的''在线体验''小节（推荐方式）\\n\\n🔗 在线体验链接：\\nhttps://modelscope.cn/studios/JasonRobert/Vibedocs\\n\\n📁 修改文件：\\n- README.md (英文版)\\n- README.zh.md (中文版)\\n\\n✨ 优化内容：\\n- 在顶部链接栏第一位添加在线体验入口\\n- 在快速开始章节突出展示在线体验（推荐）\\n- 添加使用步骤说明\\n- 重新组织为：在线体验 + 本地部署两个选项\\\")\"\n ],\n \"deny\": [],\n \"ask\": []\n }\n}"}}}} |