From f6cb1cb1746e2fadbd0e7f313006fbd8c2ef45ff Mon Sep 17 00:00:00 2001 From: lintsinghua <129816813+lintsinghua@users.noreply.github.com> Date: Sun, 19 Oct 2025 22:42:31 +0800 Subject: [PATCH] Revise README to remove development and troubleshooting info Removed development guidelines and troubleshooting sections from the README. --- README.md | 64 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 773a317..bf50b98 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ 2. 创建新的 API Key 3. 将 API Key 添加到 `.env` 文件中的 `VITE_GEMINI_API_KEY` -#### Supabase 配置 (可选) +#### Supabase 配置 1. 访问 [Supabase](https://supabase.com/) 创建新项目 2. 在项目设置中获取 URL 和匿名密钥 3. 运行数据库迁移脚本: @@ -237,14 +237,6 @@ XCodeReviewer/ 4. 监控任务执行状态 5. 查看详细的问题报告 -## 🔧 开发指南 - -### 代码规范 -- 使用 TypeScript 进行类型安全开发 -- 遵循 ESLint 和 Biome 代码规范 -- 使用 Prettier 进行代码格式化 -- 组件采用函数式组件 + Hooks - ### 构建和部署 ```bash # 开发模式 @@ -282,57 +274,6 @@ pnpm lint 4. 推送到分支 (`git push origin feature/AmazingFeature`) 5. 创建一个 **Pull Request** -## 🚨 故障排除 - -### 常见问题 - -#### 1. 白屏问题 -**问题**: 应用启动后显示白屏 -**解决方案**: -- 检查浏览器控制台是否有错误信息 -- 确认已正确配置 `VITE_GEMINI_API_KEY` 环境变量 -- 检查网络连接,确保能访问 Google AI API - -#### 2. API 调用失败 -**问题**: 代码分析功能无法使用 -**解决方案**: -- 验证 Gemini API Key 是否有效 -- 检查 API 配额是否用完 -- 确认网络能访问 `https://generativelanguage.googleapis.com` - -#### 3. 数据库连接问题 -**问题**: 项目数据无法保存 -**解决方案**: -- 检查 Supabase 配置是否正确 -- 确认数据库表结构已正确创建 -- 验证 RLS (Row Level Security) 策略 - -#### 4. 构建失败 -**问题**: `pnpm build` 命令失败 -**解决方案**: -```bash -# 清理缓存 -pnpm clean -rm -rf node_modules -pnpm install - -# 检查 TypeScript 类型错误 -pnpm type-check -``` - -### 调试模式 -启用调试模式查看详细日志: -```bash -# 设置调试环境变量 -export DEBUG=true -pnpm dev -``` - -### 性能优化 -- 使用 `pnpm` 而不是 `npm` 获得更快的安装速度 -- 启用 Vite 的预构建缓存 -- 配置 CDN 加速静态资源加载 - ## 🙏 致谢 - **[Google Gemini AI](https://ai.google.dev/)**: 提供强大的 AI 分析能力 @@ -346,8 +287,9 @@ pnpm dev - **项目链接**: [https://github.com/lintsinghua/XCodeReviewer](https://github.com/lintsinghua/XCodeReviewer) - **问题反馈**: [Issues](https://github.com/lintsinghua/XCodeReviewer/issues) +- **作者邮箱**: tsinghuaiiilove@gmail.com --- ⭐ 如果这个项目对您有帮助,请给我们一个 **Star**!您的支持是我们不断前进的动力! -[![Star History](https://api.star-history.com/svg?repos=lintsinghua/XCodeReviewer&type=Date)](https://star-history.com/#lintsinghua/XCodeReviewer&Date) \ No newline at end of file +[![Star History](https://api.star-history.com/svg?repos=lintsinghua/XCodeReviewer&type=Date)](https://star-history.com/#lintsinghua/XCodeReviewer&Date)