项目介绍¶
项目是什么¶
课狐 ClassFox 是一个运行在 Windows 桌面上的课堂辅助小窗应用。它监听麦克风音频,将课堂语音转成文本,再把文本用于关键词提醒、课堂救场、进度追踪和课后总结。
项目采取“小壳层 + 前端界面 + 本地后端服务”的结构:
- Tauri 负责桌面壳层、窗口生命周期和发布交付
- React 负责浮窗 UI、状态呈现和用户交互
- FastAPI 负责 ASR 接入、转录管理、关键词检测和 LLM 调用
产品目标¶
这个项目试图解决的是课堂里的几个高频小问题,而不是做一套泛化办公 AI:
- 老师突然点名、提问、布置任务时,用户来不及反应。
- 用户短暂走神后,不知道老师当前讲到了哪里。
- 课后回忆课堂内容成本高,笔记整理不稳定。
- 资料上传、监控启动、总结生成分散在不同工具里,使用路径过长。
当前能力边界¶
已实现¶
- 课堂实时监听与文本落盘
- 红色告警词与黄色提醒词检测
- 资料上传并转为可引用文本
- 救场回答与追问
- 课堂进度总结与追问
- 自动课后总结
- 打包态自动启动内置后端
- 应用内直接编辑后端配置
不以此项目为目标¶
- 跨平台完整兼容
- 企业级账号体系或云同步
- 长时间后台守护型录音平台
- 面向所有会议场景的通用转录系统
技术栈¶
| 层级 | 技术 |
|---|---|
| 桌面端 | Tauri 2、Rust |
| 前端 | React 19、TypeScript、Vite、Tailwind CSS v4 |
| 后端 | FastAPI、Uvicorn、Python 3.11 |
| 音频与识别 | PyAudio、SpeechRecognition、DashScope、Seed-ASR |
| 大模型 | OpenAI Compatible API |
| 文档解析 | python-pptx、pypdf、python-docx |
| 打包 | PyInstaller、Tauri build、PowerShell 脚本 |
仓库结构速览¶
ClassAssistant/
├── api-service/ # FastAPI 后端与业务服务
├── app-ui/ # React 前端与 Tauri 壳层
├── data/ # 运行时转录、关键词、引用资料、总结文件
├── docs/ # 项目文档与供应商参考资料
├── build.ps1 # 一键打包脚本
├── build.bat # 打包脚本入口
└── dev.bat # 开发模式启动脚本
推荐阅读下一步¶
- 想先理解系统整体结构,请继续阅读系统架构。
- 想尽快跑起来,请直接跳到环境准备。
- 想从代码层面入手,请优先阅读代码模块说明。