Skip to content

Repository files navigation

LearnProj - 智能项目学习工具

一个零命令操作的桌面应用程序,帮助您快速理解GitHub项目的架构和代码结构。

🚀 快速开始

方法1:桌面启动器(推荐)

npm run desktop

方法2:Web界面

npm run web

然后在浏览器中打开:http://localhost:8080

方法3:命令行(高级用户)

npm start

📋 功能特性

  • 零命令操作 - 完全图形化界面,无需记忆命令
  • 智能分析 - 自动检测项目结构和依赖关系
  • 可视化展示 - 生成Mermaid图表展示架构
  • 交互式课程 - 生成HTML格式的学习材料
  • 进度跟踪 - 记录学习进度和成就
  • 多语言支持 - 支持JS/TS、Python、Go、Java等项目
  • 安全存储 - API密钥本地加密存储
  • 离线模式 - 无需网络也能进行基础分析

🎯 使用步骤

  1. 配置API - 在配置页面输入DeepSeek API凭据
  2. 选择项目 - 点击"选择文件夹"选择要学习的GitHub项目
  3. 运行分析 - 选择分析类型并运行项目分析
  4. 查看结果 - 查看生成的依赖图、模块结构和框架信息
  5. 开始学习 - 打开生成的交互式课程开始学习

🔧 技术栈

  • 前端:HTML5, CSS3, JavaScript (ES6+)
  • 后端:Node.js, TypeScript
  • 分析引擎:自定义依赖解析器
  • 可视化:Mermaid.js
  • 打包:pkg (可执行文件)

📦 打包为可执行文件

# 打包为Windows可执行文件
npm run build:exe

# 打包后的文件位置
dist/learnproj.exe

🔒 安全说明

  • API密钥使用掩码显示,不会明文暴露
  • 所有配置数据存储在本地用户目录
  • 支持离线模式,无需联网即可分析项目结构
  • 不会上传您的代码到任何服务器

🛠️ 开发

# 安装依赖
npm install

# 开发模式
npm run web

# 测试CLI功能
npm start

📄 许可证

MIT License

🤝 贡献

欢迎提交Issue和Pull Request!

📞 支持

如有问题,请在GitHub Issues中提交。

About

桌面端 GitHub 项目学习工具 — 零命令行图形界面,快速理解开源项目的架构与代码结构(Electron + Node.js)

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages