WuYanBo
/
CodeReview
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
CodeReview/README.md

136 lines
6.4 KiB
Markdown
Raw Normal View History

更新README.md，移除多余的标题行，并在文末添加Star历史链接，以便用户查看项目的受欢迎程度。
2025-09-20 13:10:16 +08:00
# XCodeReviewer - 您的智能代码审计伙伴 🚀
Update README.md
2025-12-05 13:32:27 +08:00
> 多Agent、PR批量自动审计版本正在开发中，敬请期待......
在README.md中添加了项目logo，并调整了布局以增强视觉效果。同时新增了logo图像文件。
2025-09-20 13:09:12 +08:00
<div style="width: 100%; max-width: 600px; margin: 0 auto;">
docs: update README image paths and version to 2.0.0-beta.1 - Update all image references from `public/` to `frontend/public/` to reflect correct project structure - Bump version badge from 1.3.4 to 2.0.0-beta.1 in README - Refresh example screenshots (example1.png, example2.png, example3.png) - Update audit report example image (审计报告示例.png) - Ensure all documentation images point to correct frontend assets location
2025-11-28 22:12:27 +08:00
<img src="frontend/public/images/logo.png" alt="XCodeReviewer Logo" style="width: 100%; height: auto; display: block; margin: 0 auto;">
在README.md中添加了项目logo，并调整了布局以增强视觉效果。同时新增了logo图像文件。
2025-09-20 13:09:12 +08:00
</div>
docs: enhance README files with additional badges - Added version, stars, and forks badges to both English and Chinese README files for improved project visibility and engagement. - Centered the badges for better presentation.
2025-10-27 17:14:33 +08:00
<div align="center">
docs: update README image paths and version to 2.0.0-beta.1 - Update all image references from `public/` to `frontend/public/` to reflect correct project structure - Bump version badge from 1.3.4 to 2.0.0-beta.1 in README - Refresh example screenshots (example1.png, example2.png, example3.png) - Update audit report example image (审计报告示例.png) - Ensure all documentation images point to correct frontend assets location
2025-11-28 22:12:27 +08:00
[![Version](https://img.shields.io/badge/version-2.0.0--beta.1-blue.svg)](https://github.com/lintsinghua/XCodeReviewer/releases)
docs: update README files with version badge and social media links - Replaced build status badge with version badge in both English and Chinese README files. - Added social media badges for stars and forks to enhance project visibility and engagement.
2025-10-27 17:13:07 +08:00
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![React](https://img.shields.io/badge/React-18-61dafb.svg)](https://reactjs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.7-3178c6.svg)](https://www.typescriptlang.org/)
feat: v2.0.0-test release Major changes: - Backend: Add report generator service with comprehensive analysis - Backend: Enhanced scan and task endpoints - Frontend: Refactor instant analysis page and export dialog - Frontend: Optimize report export service - Infrastructure: Simplify Dockerfile and update docker-compose - Docs: Streamline README documentation - Assets: Add logo with transparent background
2025-11-28 20:34:15 +08:00
[![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-009688.svg)](https://fastapi.tiangolo.com/)
[![Python](https://img.shields.io/badge/Python-3.13+-3776ab.svg)](https://www.python.org/)
Update README.md
2025-11-09 20:32:51 +08:00
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/lintsinghua/XCodeReviewer)
docs: enhance README files with additional badges - Added version, stars, and forks badges to both English and Chinese README files for improved project visibility and engagement. - Centered the badges for better presentation.
2025-10-27 17:14:33 +08:00
docs: update README files with version badge and social media links - Replaced build status badge with version badge in both English and Chinese README files. - Added social media badges for stars and forks to enhance project visibility and engagement.
2025-10-27 17:13:07 +08:00
[![Stars](https://img.shields.io/github/stars/lintsinghua/XCodeReviewer?style=social)](https://github.com/lintsinghua/XCodeReviewer/stargazers)
[![Forks](https://img.shields.io/github/forks/lintsinghua/XCodeReviewer?style=social)](https://github.com/lintsinghua/XCodeReviewer/network/members)
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
Update README.md
2025-10-29 22:22:38 +08:00
[![Sponsor](https://img.shields.io/badge/Sponsor-赞助-blueviolet)](https://github.com/lintsinghua/lintsinghua.github.io/issues/1)
docs: enhance README files with additional badges - Added version, stars, and forks badges to both English and Chinese README files for improved project visibility and engagement. - Centered the badges for better presentation.
2025-10-27 17:14:33 +08:00
</div>
style: enhance README layout for star project button - Updated the layout of the star project button in both English and Chinese README files for improved responsiveness and visual appeal. - Adjusted the div styling to center the button and ensure it scales properly across different screen sizes.
2025-10-27 17:20:18 +08:00
<div style="width: 100%; max-width: 600px; margin: 0 auto;">
docs: add project star button to README files - Included a centered star project button in both English and Chinese README files to encourage user engagement.
2025-10-27 17:06:17 +08:00
<a href="https://github.com/lintsinghua/XCodeReviewer">
docs: update README image paths and version to 2.0.0-beta.1 - Update all image references from `public/` to `frontend/public/` to reflect correct project structure - Bump version badge from 1.3.4 to 2.0.0-beta.1 in README - Refresh example screenshots (example1.png, example2.png, example3.png) - Update audit report example image (审计报告示例.png) - Ensure all documentation images point to correct frontend assets location
2025-11-28 22:12:27 +08:00
<img src="frontend/public/star-me-cn.svg" alt="Star this project" style="width: 100%; height: auto; display: block; margin: 0 auto;" />
docs: add project star button to README files - Included a centered star project button in both English and Chinese README files to encourage user engagement.
2025-10-27 17:06:17 +08:00
</a>
</div>
feat: v2.0.0-test release Major changes: - Backend: Add report generator service with comprehensive analysis - Backend: Enhanced scan and task endpoints - Frontend: Refactor instant analysis page and export dialog - Frontend: Optimize report export service - Infrastructure: Simplify Dockerfile and update docker-compose - Docs: Streamline README documentation - Assets: Add logo with transparent background
2025-11-28 20:34:15 +08:00
**XCodeReviewer** 是一个由大型语言模型（LLM）驱动的现代化代码审计平台，采用前后端分离架构，旨在为开发者提供智能、全面且极具深度的代码质量分析和审查服务。
docs(readme): Add online demo section to both README files - Moved online demo section to a more prominent location in both Chinese and English README files - Ensured consistent placement and formatting of online demo link - Improved visibility of the online demo URL for easier access - Maintained existing documentation structure and style
2025-11-11 18:24:55 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
## 📚 文档导航
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
| 文档 | 说明 |
|------|------|
| [部署指南](docs/DEPLOYMENT.md) | Docker 和本地开发部署说明 |
| [配置说明](docs/CONFIGURATION.md) | 后端配置、数据库模式、API 中转站 |
| [LLM 平台支持](docs/LLM_PROVIDERS.md) | 10+ LLM 平台配置和 API Key 获取 |
| [常见问题](docs/FAQ.md) | 常见问题解答 |
| [贡献指南](CONTRIBUTING.md) | 如何参与项目贡献 |
| [安全政策](SECURITY.md) | 代码隐私与安全说明 |
| [免责声明](DISCLAIMER.md) | 使用条款与免责声明 |
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
## 🌟 为什么选择 XCodeReviewer？
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
- **AI 驱动的深度分析**：超越传统静态分析，理解代码意图，发现深层逻辑问题
- **多维度、全方位评估**：从安全性、性能、可维护性到代码风格，提供 360 度无死角的质量评估
- **清晰、可行的修复建议**：独创 What-Why-How 模式，不仅告诉您"是什么"问题，还解释"为什么"，并提供"如何修复"的具体代码示例
- **多平台 LLM 支持**: 已实现 10+ 主流平台 API 调用功能（Gemini、OpenAI、Claude、通义千问、DeepSeek、智谱AI、Kimi、文心一言、MiniMax、豆包、Ollama 本地大模型）
- **前后端分离架构**：采用 React + FastAPI 现代化架构，后端使用 LiteLLM 统一适配多种 LLM 平台
- **可视化运行时配置**：无需重新构建镜像，直接在浏览器中配置所有 LLM 参数和 API Keys
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
## 🎬 项目演示
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
refactor(project-structure): Restructure project architecture and improve code organization - Reorganize source code into feature-based and shared module structure - Move components, services, and hooks into more logical directories - Update project configuration files to reflect new structure - Add .env.example template for easier environment setup - Enhance README.md with more detailed project information and setup instructions - Consolidate utility functions and hooks into shared modules - Remove deprecated or unused files and components - Improve type definitions and configuration management - Update routing and main application configuration This refactoring aims to improve code maintainability, readability, and scalability by implementing a more modular and organized project structure.
2025-10-22 15:12:59 +08:00
#### 智能仪表盘
docs: update README image paths and version to 2.0.0-beta.1 - Update all image references from `public/` to `frontend/public/` to reflect correct project structure - Bump version badge from 1.3.4 to 2.0.0-beta.1 in README - Refresh example screenshots (example1.png, example2.png, example3.png) - Update audit report example image (审计报告示例.png) - Ensure all documentation images point to correct frontend assets location
2025-11-28 22:12:27 +08:00
![智能仪表盘](frontend/public/images/example1.png)
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
*实时展示项目统计、质量趋势和系统性能*
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
refactor(project-structure): Restructure project architecture and improve code organization - Reorganize source code into feature-based and shared module structure - Move components, services, and hooks into more logical directories - Update project configuration files to reflect new structure - Add .env.example template for easier environment setup - Enhance README.md with more detailed project information and setup instructions - Consolidate utility functions and hooks into shared modules - Remove deprecated or unused files and components - Improve type definitions and configuration management - Update routing and main application configuration This refactoring aims to improve code maintainability, readability, and scalability by implementing a more modular and organized project structure.
2025-10-22 15:12:59 +08:00
#### 即时分析
docs: update README image paths and version to 2.0.0-beta.1 - Update all image references from `public/` to `frontend/public/` to reflect correct project structure - Bump version badge from 1.3.4 to 2.0.0-beta.1 in README - Refresh example screenshots (example1.png, example2.png, example3.png) - Update audit report example image (审计报告示例.png) - Ensure all documentation images point to correct frontend assets location
2025-11-28 22:12:27 +08:00
![即时分析](frontend/public/images/example2.png)
更新README.md - 改进项目描述，增加功能介绍和使用指南
2025-09-20 11:58:22 +08:00
*支持代码片段快速分析，提供详细的 What-Why-How 解释和修复建议*
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
refactor(project-structure): Restructure project architecture and improve code organization - Reorganize source code into feature-based and shared module structure - Move components, services, and hooks into more logical directories - Update project configuration files to reflect new structure - Add .env.example template for easier environment setup - Enhance README.md with more detailed project information and setup instructions - Consolidate utility functions and hooks into shared modules - Remove deprecated or unused files and components - Improve type definitions and configuration management - Update routing and main application configuration This refactoring aims to improve code maintainability, readability, and scalability by implementing a more modular and organized project structure.
2025-10-22 15:12:59 +08:00
#### 项目管理
docs: update README image paths and version to 2.0.0-beta.1 - Update all image references from `public/` to `frontend/public/` to reflect correct project structure - Bump version badge from 1.3.4 to 2.0.0-beta.1 in README - Refresh example screenshots (example1.png, example2.png, example3.png) - Update audit report example image (审计报告示例.png) - Ensure all documentation images point to correct frontend assets location
2025-11-28 22:12:27 +08:00
![项目管理](frontend/public/images/example3.png)
更新README.md - 改进项目描述，增加功能介绍和使用指南
2025-09-20 11:58:22 +08:00
*集成 GitHub/GitLab 仓库，支持多语言项目审计和批量代码分析*
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: add audit report section to README - Add new "审计报告" (Audit Report) section with example screenshot - Include description of professional code audit report features - Document support for PDF/JSON export formats - Highlight detailed issue analysis and fix recommendations - Improve README documentation completeness with audit report showcase
2025-11-28 23:11:46 +08:00
#### 审计报告
![审计报告](frontend/public/images/审计报告示例.png)
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
*专业的代码审计报告，支持导出 PDF/JSON 格式*
docs: add audit report section to README - Add new "审计报告" (Audit Report) section with example screenshot - Include description of professional code audit report features - Document support for PDF/JSON export formats - Highlight detailed issue analysis and fix recommendations - Improve README documentation completeness with audit report showcase
2025-11-28 23:11:46 +08:00
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
## 🚀 快速开始
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
### Docker Compose 部署（推荐）
feat(deployment): Add Vercel deployment support and configuration - Add .vercelignore to exclude unnecessary files from Vercel deployment - Update README.md and README_EN.md with detailed Vercel deployment instructions - Create vercel.json with deployment configuration - Add one-click deployment button and multiple deployment methods - Include environment variable setup guidance - Highlight Vercel deployment advantages and important notes - Improve documentation for easier deployment and setup process Enhances project deployment flexibility and provides clear, step-by-step guidance for users looking to quickly deploy the application on Vercel.
2025-11-11 17:01:29 +08:00
```bash
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
# 克隆项目
feat: v2.0.0-test release Major changes: - Backend: Add report generator service with comprehensive analysis - Backend: Enhanced scan and task endpoints - Frontend: Refactor instant analysis page and export dialog - Frontend: Optimize report export service - Infrastructure: Simplify Dockerfile and update docker-compose - Docs: Streamline README documentation - Assets: Add logo with transparent background
2025-11-28 20:34:15 +08:00
git clone https://github.com/lintsinghua/XCodeReviewer.git
cd XCodeReviewer
feat(deployment): Add Vercel deployment support and configuration - Add .vercelignore to exclude unnecessary files from Vercel deployment - Update README.md and README_EN.md with detailed Vercel deployment instructions - Create vercel.json with deployment configuration - Add one-click deployment button and multiple deployment methods - Include environment variable setup guidance - Highlight Vercel deployment advantages and important notes - Improve documentation for easier deployment and setup process Enhances project deployment flexibility and provides clear, step-by-step guidance for users looking to quickly deploy the application on Vercel.
2025-11-11 17:01:29 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
# 配置后端环境变量
feat: v2.0.0-test release Major changes: - Backend: Add report generator service with comprehensive analysis - Backend: Enhanced scan and task endpoints - Frontend: Refactor instant analysis page and export dialog - Frontend: Optimize report export service - Infrastructure: Simplify Dockerfile and update docker-compose - Docs: Streamline README documentation - Assets: Add logo with transparent background
2025-11-28 20:34:15 +08:00
cp backend/env.example backend/.env
# 编辑 backend/.env 文件，配置 LLM API Key 等参数
feat(deployment): Add Vercel deployment support and configuration - Add .vercelignore to exclude unnecessary files from Vercel deployment - Update README.md and README_EN.md with detailed Vercel deployment instructions - Create vercel.json with deployment configuration - Add one-click deployment button and multiple deployment methods - Include environment variable setup guidance - Highlight Vercel deployment advantages and important notes - Improve documentation for easier deployment and setup process Enhances project deployment flexibility and provides clear, step-by-step guidance for users looking to quickly deploy the application on Vercel.
2025-11-11 17:01:29 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
# 启动所有服务
feat: v2.0.0-test release Major changes: - Backend: Add report generator service with comprehensive analysis - Backend: Enhanced scan and task endpoints - Frontend: Refactor instant analysis page and export dialog - Frontend: Optimize report export service - Infrastructure: Simplify Dockerfile and update docker-compose - Docs: Streamline README documentation - Assets: Add logo with transparent background
2025-11-28 20:34:15 +08:00
docker-compose up -d
feat(deployment): Add Vercel deployment support and configuration - Add .vercelignore to exclude unnecessary files from Vercel deployment - Update README.md and README_EN.md with detailed Vercel deployment instructions - Create vercel.json with deployment configuration - Add one-click deployment button and multiple deployment methods - Include environment variable setup guidance - Highlight Vercel deployment advantages and important notes - Improve documentation for easier deployment and setup process Enhances project deployment flexibility and provides clear, step-by-step guidance for users looking to quickly deploy the application on Vercel.
2025-11-11 17:01:29 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
# 访问应用
feat: v2.0.0-test release Major changes: - Backend: Add report generator service with comprehensive analysis - Backend: Enhanced scan and task endpoints - Frontend: Refactor instant analysis page and export dialog - Frontend: Optimize report export service - Infrastructure: Simplify Dockerfile and update docker-compose - Docs: Streamline README documentation - Assets: Add logo with transparent background
2025-11-28 20:34:15 +08:00
# 前端: http://localhost:5173
# 后端 API: http://localhost:8000
# API 文档: http://localhost:8000/docs
feat(deployment): Add Vercel deployment support and configuration - Add .vercelignore to exclude unnecessary files from Vercel deployment - Update README.md and README_EN.md with detailed Vercel deployment instructions - Create vercel.json with deployment configuration - Add one-click deployment button and multiple deployment methods - Include environment variable setup guidance - Highlight Vercel deployment advantages and important notes - Improve documentation for easier deployment and setup process Enhances project deployment flexibility and provides clear, step-by-step guidance for users looking to quickly deploy the application on Vercel.
2025-11-11 17:01:29 +08:00
```
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
更多部署方式请参考 [部署指南](docs/DEPLOYMENT.md)。
feat(deployment): Add Docker support and deployment configuration - Add Dockerfile for multi-stage build with Node.js and Nginx - Create docker-compose.yml for simplified container deployment - Add .dockerignore to optimize Docker build context - Configure nginx.conf with performance and security optimizations - Update README.md and README_EN.md with Docker deployment instructions - Enhance database configuration to support optional Supabase integration - Improve environment configuration handling for local and containerized environments Enables easier deployment and provides a standardized container-based setup for the application.
2025-10-23 00:13:48 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
## ✨ 核心功能
更新README.md - 改进项目描述，增加功能介绍和使用指南
2025-09-20 11:58:22 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
- **🚀 项目管理**：一键集成 GitHub/GitLab，支持多语言项目审计，ZIP 文件上传
- **⚡ 即时分析**：代码片段快速分析，10+ 种语言支持，历史记录和报告导出
- **🧠 智能审计**：五大核心维度检测（Bug、安全、性能、风格、可维护性）
- **💡 可解释性分析**：What-Why-How 模式，精准代码定位
- **📊 可视化报告**：质量仪表盘、趋势分析、JSON/PDF 导出
- **⚙️ 系统管理**：运行时配置、数据库管理、用户认证
Refactor LLM configuration and add support for multiple providers in environment setup. Update README and example files to reflect new configuration options and usage instructions. Introduce LLM service architecture with adapters for various AI providers.
2025-10-24 10:59:05 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
## 🎯 未来计划
Refactor LLM configuration and add support for multiple providers in environment setup. Update README and example files to reflect new configuration options and usage instructions. Introduce LLM service architecture with adapters for various AI providers.
2025-10-24 10:59:05 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
- **✅ 多平台 LLM 支持**: 已实现 10+ 主流平台 API 调用功能
- **✅ 本地模型支持**: 已加入对 Ollama 本地大模型的调用功能
- **✅ 可视化配置管理**: 已实现运行时配置系统
- **✅ 专业报告文件生成**: 支持 JSON 和 PDF 格式导出
- **✅ 前后端分离架构**: 采用 FastAPI + React 现代化架构
- **✅ 用户认证系统**: JWT Token 认证和用户管理
- **🚧 CI/CD 集成与 PR 自动审查**: 计划实现 GitHub/GitLab CI 集成
- **Multi-Agent Collaboration**: 考虑引入多智能体协作架构
- **审计标准自定义**: 支持通过 YAML/JSON 定义团队特定的编码规范
Add support for Ollama local models in LLM configuration and enhance README documentation. Update .env.example to include Ollama settings, improve error handling in code analysis, and refine logging for LLM interactions.
2025-10-24 12:25:29 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
## 🤝 贡献
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
我们欢迎所有形式的贡献！详情请参考 [贡献指南](CONTRIBUTING.md)。
更新README.md - 改进项目描述，增加功能介绍和使用指南
2025-09-20 11:58:22 +08:00
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
## 📞 联系我们
更新README.md - 改进项目描述，增加功能介绍和使用指南
2025-09-20 11:58:22 +08:00
- **项目链接**: [https://github.com/lintsinghua/XCodeReviewer](https://github.com/lintsinghua/XCodeReviewer)
- **问题反馈**: [Issues](https://github.com/lintsinghua/XCodeReviewer/issues)
Update README.md
2025-10-28 19:23:17 +08:00
- **作者邮箱**: lintsinghua@qq.com（合作请注明来意）
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
feat: v2.0.0-test release Major changes: - Backend: Add report generator service with comprehensive analysis - Backend: Enhanced scan and task endpoints - Frontend: Refactor instant analysis page and export dialog - Frontend: Optimize report export service - Infrastructure: Simplify Dockerfile and update docker-compose - Docs: Streamline README documentation - Assets: Add logo with transparent background
2025-11-28 20:34:15 +08:00
---
docs: add reflections on open source journey to README files - Included a new section detailing the author's experiences and challenges in maintaining the project as an undergraduate student. - Expressed gratitude towards the Linux.do community for their support and contributions. - Highlighted the importance of community collaboration and ongoing project optimization efforts.
2025-10-27 19:19:04 +08:00
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
⭐ 如果这个项目对您有帮助，请给我们一个 **Star**！
Update README.md
2025-10-23 11:48:13 +08:00
Revise README to remove development and troubleshooting info Removed development guidelines and troubleshooting sections from the README.
2025-10-19 22:42:31 +08:00
[![Star History](https://api.star-history.com/svg?repos=lintsinghua/XCodeReviewer&type=Date)](https://star-history.com/#lintsinghua/XCodeReviewer&Date)
feat: v2.0.0-test release Major changes: - Backend: Add report generator service with comprehensive analysis - Backend: Enhanced scan and task endpoints - Frontend: Refactor instant analysis page and export dialog - Frontend: Optimize report export service - Infrastructure: Simplify Dockerfile and update docker-compose - Docs: Streamline README documentation - Assets: Add logo with transparent background
2025-11-28 20:34:15 +08:00
Update README.md
2025-10-23 11:30:35 +08:00
---
docs: add comprehensive documentation and guidelines - Add CONTRIBUTING.md with development setup, code standards, and contribution workflow - Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities - Add SECURITY.md for code security and privacy guidelines - Add docs/CONFIGURATION.md with backend configuration and database setup instructions - Add docs/DEPLOYMENT.md with Docker and local development deployment guides - Add docs/FAQ.md with frequently asked questions and troubleshooting - Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup - Update README.md with documentation navigation table and streamlined feature descriptions - Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00
⚠️ **重要提示**：使用本工具前，请务必阅读 [安全政策](SECURITY.md) 和 [免责声明](DISCLAIMER.md)。