Skip to content

Latest commit

 

History

64 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

学习你的项目 · Learn Your Project

面向 VIBE CODING 时代的纯静态项目学习助手。无后端、零依赖运行时:既能研读优秀的开源项目,也能把你亲手让 AI 写出来的 VibeCoding 项目丢进来——看清 AI 到底做了什么、哪里有坑,快速把项目握在自己手里,再带着清晰指令去指挥 AI 下一步。配置任意 OpenAI 兼容大模型 API,粘贴 GitHub 仓库地址,一键生成专业评估报告与零基础图文教学,并以项目本身为知识库做精准问答。

密钥仅存于浏览器本地,不会上传到任何服务器。

它解决什么问题

在 VibeCoding 盛行的时代,有时自己让 AI 写出来的项目,自己却并不真正了解。这个项目帮你:

  • 📖 学别人的好项目:把任意开源仓库变成可阅读、可学习、可问答的知识库。
  • 🔍 看清自己的 VibeCoding 项目:自动体检,指出 AI 可能生成的孤儿文件、巨型「神文件」、循环依赖、缺失测试/README 等坑。
  • 🎯 更好地指挥 AI:生成一份可一键复制的「指挥 AI 的行动清单」,每条都是可粘贴给编码 Agent(Cursor / Claude / Copilot 等)的精准指令,避免 AI 凭空脑补、改错地方。

特性

  • 🔌 主流大模型原生协议:原生支持 OpenAI 兼容(阿里云百炼 / DeepSeek / Moonshot / 智谱 / 混元 / Ollama / OpenAI…)以及 Anthropic ClaudeGoogle Gemini 官方协议(Gemini 还支持原生 Embedding 与批量向量化),无需中转代理;各协议基地址自动适配(需允许浏览器跨域 CORS,主流厂商均原生支持)。
  • 🌱 纯浏览器加载 GitHub 仓库:经 GitHub API 在前端直接拉取,目录深的大仓库自动 BFS 分页,避免 504;支持私有 / 企业仓库(填 GitHub Token,仅存本机)。
  • 📁 本地文件夹也能读(杀手锏):用 File System Access API 把还没 push 的 VibeCoding 项目直接拖进来读懂——竞品都只能解析公开仓库,这是纯静态才能做到的差异点。
  • 🎯 指挥 AI 的行动清单(VibeCoding 精髓):基于真实文件扫描(孤儿文件 / 巨型文件 / 循环依赖 / 测试 / README / 入口清晰度),给出「AI 自主度风险」指数与可复制的下一步指令;勾选「这是我自己的 VibeCoding 项目」即开启。
  • 📊 一键评估报告 + 📚 一键零基础教学(含 Mermaid 图解、GitHub/官网/B 站权威资源外链;评估报告中附「给项目主人的行动建议」)。
  • 💬 基于项目的问答(检索已升级):默认「代码感知分块」(按函数 / 类 / 声明边界切分,非纯文本切块);可切换「深度向量检索」(用你配置的同一 API 算 Embedding,浏览器本地余弦相似度,无后端);问答前可用 LLM 把问题改写成关键词 / 代码术语,中文场景更准。
  • 🗺️ 项目地图 Tab:分层可折叠目录树(文件可点击看真实代码)+ 模块依赖 / 调用图,结合代码知识图谱快速建立项目心智模型。
  • 🔍 AI 变更审计:读取最近 commit 的变更文件,生成「这次 AI 改了什么 / 影响哪些模块 / 风险在哪」的速览,下达下一条指令前先掌握全局。
  • 💾 本机缓存:已分析项目的结构化摘要缓存到 localStorage,二次问答免全量重拉;7 天内的仓库可「从缓存秒开」。
  • 📚 一键体验示例:内置 axios / koa / express 等预置仓库,配好模型点一下就能看效果。
  • 📝 单文件导出:报告 / 教学可导出为独立 HTML、PDF 或 Markdown,沉淀成学习笔记或分享到社区。
  • 🕸️ 代码知识图谱 / 架构健康度 / 代码地图 / 目录可点击导航:本地扫描关系智能,毫秒级,无需大模型。
  • 🎨 自然有机风(暖奶油 / 鼠尾草 / 琥珀),模块卡片化输出,链接三态区分(未点击 / 可点击 / 点击过)。
  • 🔄 加载门控:项目未完全载入前禁用生成与问答按钮,全程转圈提示阶段进度。

使用

本项目为纯静态站点,部署到 GitHub Pages 后访问 https://<你的用户名>.github.io/<仓库名>/(由 main 分支根目录托管)。本地预览:

  1. 「模型配置」填写 API Key / 基地址 / 模型 → 点击「验证配置」。
  2. 「加载仓库」粘贴 https://github.com/owner/repo;若是你自己的 VibeCoding 项目,勾选「🎯 这是我自己的 VibeCoding 项目」→ 点击「加载仓库」。
  3. 「学习空间」查看「🎯 指挥 AI 的行动清单」,生成报告 / 教学,或在「项目问答」提问。

本地预览

任意静态服务器均可,例如:

npx serve .          #
python -m http.server 8000

演示(Demo)

演示 GIF 发布前录制(放入 docs/demo.gif)。推荐 30 秒流程:① 填模型配置并「验证配置」→ ② 粘贴一个 VibeCoding 项目仓库并勾选「🎯 这是我自己的 VibeCoding 项目」→ ③「加载仓库」后看「指挥 AI 的行动清单」→ ④ 点「🔍 AI 变更审计」→ ⑤ 在「项目问答」追问。 可用 scripts/record-demo.mjs 自动驱动页面并录屏(需先 npm i playwright + npx playwright install chromium)。该脚本依赖真实 API 配置:通过环境变量 DEMO_URL / DEMO_API_KEY / DEMO_BASE_URL / DEMO_MODEL / DEMO_REPO 注入,key 仅供本地录制、请替换为临时 key 且勿提交;脚本会先完成「验证配置」再执行后续步骤(验证/加载/审计/问答均会真实调用 API,需联网)。录制产物为 docs/*.webm,再用 ffmpeg -i docs/*.webm -vf "fps=12,scale=720:-1" docs/demo.gif 转 GIF。选择器按页面实际 DOM(id 匹配)编写,若元素 id 变动请同步更新脚本。

与 DeepWiki / Zread 对比

本项目的差异化定位是纯静态 + 隐私 + 模型自由 + 读懂自己的 VibeCoding 项目

维度 学习你的项目(本项目) DeepWiki / Zread 等
部署形态 纯静态 SPA,零后端,可托管在 GitHub Pages 云端服务,需服务端索引
隐私 密钥仅存浏览器本地,文件不出本机 仓库内容上传到对方服务端
模型 OpenAI 兼容 / Claude / Gemini 原生协议(百炼 / DeepSeek / 本地 Ollama / Anthropic / Google…) 绑定自家模型
本地 / 未公开项目 支持本地文件夹(File System Access API)、私有仓库 Token ❌ 通常仅限公开仓库
VibeCoding 场景 ✅ 指挥 AI 行动清单、AI 变更审计、缓存秒开 偏通用文档 / 问答
依赖图 / 调用图 ✅ 项目地图 + 代码知识图谱 ✅ 交互式图表(云端算力)
检索 TF-IDF + 可选深度向量检索 + 查询改写 云端向量 / AST 索引
离线 / 自托管 ✅ 完全可自托管

核心结论:当你的项目还没公开、或你不想把代码交给第三方云端时,本项目是更稳的选择;同时它把"看清自己的 VibeCoding 项目、更好地指挥 AI"作为一等公民。

说明

  • 浏览器会自动使用系统代理,无需单独配置。
  • 教学中的外链由大模型依据项目技术栈生成,使用前请自行核实链接有效性。

🌿 自然有机风 · 纯静态 · 隐私友好

About

学习你的项目 · 纯静态 GitHub 项目学习助手(评估报告 / 零基础教学 / 项目问答)

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages