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

212 lines
7.6 KiB
Markdown
Raw Normal View History

docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
<p align="center">
<img src="frontend/public/images/logo.png" alt="XCodeReviewer Logo" width="200">
</p>
<h1 align="center">🛡️ XCodeReviewer</h1>
<p align="center">
<strong>让 AI 成为你的代码安全守护者</strong>
</p>
<p align="center">
<em>告别繁琐的人工审计，拥抱智能化代码安全新时代</em>
</p>
<p align="center">
<a href="https://github.com/lintsinghua/XCodeReviewer/releases"><img src="https://img.shields.io/badge/version-2.0.0--beta.1-blue.svg" alt="Version"></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"></a>
<a href="https://reactjs.org/"><img src="https://img.shields.io/badge/React-18-61dafb.svg" alt="React"></a>
<a href="https://fastapi.tiangolo.com/"><img src="https://img.shields.io/badge/FastAPI-0.100+-009688.svg" alt="FastAPI"></a>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.13+-3776ab.svg" alt="Python"></a>
<a href="https://deepwiki.com/lintsinghua/XCodeReviewer"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
</p>
<p align="center">
<a href="https://github.com/lintsinghua/XCodeReviewer/stargazers"><img src="https://img.shields.io/github/stars/lintsinghua/XCodeReviewer?style=social" alt="Stars"></a>
<a href="https://github.com/lintsinghua/XCodeReviewer/network/members"><img src="https://img.shields.io/github/forks/lintsinghua/XCodeReviewer?style=social" alt="Forks"></a>
<a href="https://github.com/lintsinghua/lintsinghua.github.io/issues/1"><img src="https://img.shields.io/badge/Sponsor-赞助-blueviolet" alt="Sponsor"></a>
</p>
更新README.md，移除多余的标题行，并在文末添加Star历史链接，以便用户查看项目的受欢迎程度。
2025-09-20 13:10:16 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
---
Update README.md
2025-12-05 13:32:27 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
## 💡 这是什么？
在README.md中添加了项目logo，并调整了布局以增强视觉效果。同时新增了logo图像文件。
2025-09-20 13:09:12 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
**你是否也有这样的困扰？**
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
- 😫 代码审计耗时耗力，人工 Review 效率低下
- 🤯 传统 SAST 工具误报率高，修复建议不知所云
- 😰 安全漏洞藏得太深，上线后才发现问题
- 🥺 想用 AI 辅助审计，但配置复杂、门槛太高
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
**XCodeReviewer 来拯救你！** 🦸‍♂️
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
我们将 10+ 主流大模型的智慧注入代码审计，让你像和资深安全专家对话一样，轻松发现代码中的安全隐患、性能瓶颈和潜在 Bug。
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: 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
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
## ✨ 为什么选择我们？
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
<table>
<tr>
<td width="50%">
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
### 🧠 真正理解你的代码
不是简单的关键词匹配，而是深度理解代码逻辑和业务意图，像人类专家一样思考。
### 🎯 What-Why-How 三步修复
- **What**: 精准定位问题所在
- **Why**: 解释为什么这是个问题
- **How**: 给出可直接使用的修复代码
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
### 🔌 10+ LLM 平台任你选
OpenAI、Claude、Gemini、通义千问、DeepSeek、智谱AI... 想用哪个用哪个，还支持 Ollama 本地部署！
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
</td>
<td width="50%">
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
### ⚡ 5 分钟快速上手
Docker 一键部署，浏览器配置 API Key，无需复杂环境搭建。
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
### 🔒 代码隐私有保障
支持 Ollama 本地模型，敏感代码不出内网，安全合规无忧。
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
### 📊 专业报告一键导出
JSON、PDF 格式随心选，审计报告直接交付，省去整理时间。
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
</td>
</tr>
</table>
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +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
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
| 智能仪表盘 | 即时分析 |
|:---:|:---:|
| ![仪表盘](frontend/public/images/example1.png) | ![即时分析](frontend/public/images/example2.png) |
| *一眼掌握项目安全态势* | *粘贴代码，秒出结果* |
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
| 项目管理 | 审计报告 |
|:---:|:---:|
| ![项目管理](frontend/public/images/example3.png) | ![审计报告](frontend/public/images/审计报告示例.png) |
| *GitHub/GitLab 无缝集成* | *专业报告，一键导出* |
## 🚀 3 步开始你的智能审计之旅
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
# 1️⃣ 克隆项目
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
# 2️⃣ 配置你的 LLM API Key
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
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
# 编辑 backend/.env，填入你的 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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
# 3️⃣ 一键启动！
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
🎉 **搞定！** 打开 http://localhost:5173 开始体验吧！
> 📖 更多部署方式请查看 [部署指南](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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
| 能力 | 描述 |
|------|------|
| 🚀 **项目管理** | GitHub/GitLab 一键导入，ZIP 上传，多语言支持 |
| ⚡ **即时分析** | 代码片段秒级分析，10+ 编程语言全覆盖 |
| 🧠 **智能审计** | Bug、安全、性能、风格、可维护性五维检测 |
| 💡 **可解释分析** | What-Why-How 模式，精准定位 + 修复建议 |
| 📊 **可视化报告** | 质量仪表盘、趋势分析、PDF/JSON 导出 |
| ⚙️ **灵活配置** | 浏览器运行时配置，无需重启服务 |
## 🤖 支持的 LLM 平台
<table>
<tr>
<td align="center"><strong>🌍 国际平台</strong></td>
<td>OpenAI GPT · Claude · Gemini · DeepSeek</td>
</tr>
<tr>
<td align="center"><strong>🇨🇳 国内平台</strong></td>
<td>通义千问 · 智谱AI · Kimi · 文心一言 · MiniMax · 豆包</td>
</tr>
<tr>
<td align="center"><strong>🏠 本地部署</strong></td>
<td>Ollama (Llama3, CodeLlama, Qwen2.5, DeepSeek-Coder...)</td>
</tr>
</table>
> 📖 详细配置请查看 [LLM 平台支持](docs/LLM_PROVIDERS.md)
## 🎯 未来蓝图
> 🚀 **我们的愿景：打造下一代智能代码安全平台，让每一行代码都值得信赖！**
| 计划 | 描述 |
|------|------|
| 🔄 **DevSecOps Pipeline** | GitHub/GitLab CI 集成，PR 级自动化安全审查 |
| 🔬 **RAG-Enhanced Detection** | CWE/CVE 知识库增强，告别高误报 |
| 🤖 **Multi-Agent Architecture** | 审计-修复-验证多智能体协同工作流 |
| 🔧 **Auto Patch Generation** | 智能漏洞定位与修复补丁自动生成 |
| 🛡️ **Hybrid Analysis Engine** | AI + SAST 工具双重验证机制 |
| 📋 **Custom Security Policies** | 声明式规则引擎，团队规范定制 |
## 📚 文档
| 文档 | 说明 |
|------|------|
| [🚀 部署指南](docs/DEPLOYMENT.md) | Docker / 本地开发部署 |
| [⚙️ 配置说明](docs/CONFIGURATION.md) | 后端配置、数据库、API 中转站 |
| [🤖 LLM 平台](docs/LLM_PROVIDERS.md) | 10+ 平台配置与 API Key 获取 |
| [❓ 常见问题](docs/FAQ.md) | FAQ |
| [🤝 贡献指南](CONTRIBUTING.md) | 如何参与贡献 |
| [🔒 安全政策](SECURITY.md) | 代码隐私与安全 |
| [📜 免责声明](DISCLAIMER.md) | 使用条款 |
## 🤝 一起让它变得更好
更新README.md - 改进项目描述，增加功能介绍和使用指南
2025-09-20 11:58:22 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
我们相信开源的力量！无论是提 Issue、贡献代码，还是分享使用心得，你的每一份参与都让 XCodeReviewer 变得更强大。
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
<p align="center">
<a href="CONTRIBUTING.md">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome">
</a>
</p>
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
**感谢每一位贡献者！** 🙏
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
[![Contributors](https://contrib.rocks/image?repo=lintsinghua/XCodeReviewer)](https://github.com/lintsinghua/XCodeReviewer/graphs/contributors)
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
更新README.md - 改进项目描述，增加功能介绍和使用指南
2025-09-20 11:58:22 +08:00
docs: 更新README.md - 根据项目实际内容重新撰写文档
2025-09-20 00:12:06 +08:00
## 📞 联系我们
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
<p align="center">
<a href="https://github.com/lintsinghua/XCodeReviewer">🏠 项目主页</a> ·
<a href="https://github.com/lintsinghua/XCodeReviewer/issues">🐛 问题反馈</a> ·
<a href="mailto:lintsinghua@qq.com">📧 联系作者</a>
</p>
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
<p align="center">
<strong>⭐ 如果这个项目对你有帮助，请给我们一个 Star！</strong>
<br>
<em>你的支持是我们持续迭代的最大动力 💪</em>
</p>
Update README.md
2025-10-23 11:48:13 +08:00
docs: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
<p align="center">
<a href="https://star-history.com/#lintsinghua/XCodeReviewer&Date">
<img src="https://api.star-history.com/svg?repos=lintsinghua/XCodeReviewer&type=Date" alt="Star History">
</a>
</p>
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: redesign README with improved visual hierarchy and content structure - Restructure header with centered logo, title, and tagline for better visual impact - Add comprehensive badge section showcasing version, tech stack, and social links - Reorganize content with new "What is this?" section addressing user pain points - Introduce "Why choose us?" comparison table highlighting key differentiators - Replace text-based feature list with visual demo table showing screenshots - Simplify quick start guide to 3-step process with clearer instructions - Add core capabilities table for better feature discoverability - Create LLM platform support table with categorized provider grouping - Add future roadmap section with planned features and improvements - Improve overall readability with better spacing, formatting, and visual hierarchy - Enhance user engagement with emoji usage and conversational tone throughout
2025-12-05 13:48:34 +08:00
<p align="center">
⚠️ 使用前请阅读 <a href="SECURITY.md">安全政策</a> 和 <a href="DISCLAIMER.md">免责声明</a>
</p>
<p align="center">
Made with ❤️ by <a href="https://github.com/lintsinghua">lintsinghua</a>
</p>