Skip to content

Commit e7c7b92

Browse files
committed
docs: rewrite README - simplify to user-facing content, remove architecture details
1 parent 2435666 commit e7c7b92

1 file changed

Lines changed: 177 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,180 @@
1+
<p align="center">
2+
<h1 align="center">📚 课伴 KeBan</h1>
3+
<p align="center"><strong>你的 AI 智能学习伙伴 — 让每一分钟网课都高效有价值</strong></p>
4+
<p align="center">
5+
<img src="https://img.shields.io/badge/status-alpha-orange.svg" alt="Status" />
6+
<img src="https://img.shields.io/badge/version-v0.3.0-blue.svg" alt="Version" />
7+
<img src="https://img.shields.io/badge/license-Private-lightgrey.svg" alt="License" />
8+
</p>
9+
</p>
10+
11+
---
12+
13+
## 📝 关于课伴
14+
15+
**课伴(KeBan)** 是一款面向学生和自学者的高效学习桌面应用。它围绕网课学习场景,将时间管理、笔记记录、记忆巩固和深度理解整合在一个工具中,帮助你建立科学的学习闭环。
16+
17+
> 💡 **核心理念:本地优先 + AI 增强可选**
18+
>
19+
> 所有核心功能 **离线完整可用**,无需任何网络依赖;联网时可按需开启 AI 辅助,作为增值能力叠加。你的学习数据,始终掌握在自己手中。
20+
21+
---
22+
23+
## ✨ 核心功能
24+
25+
课伴围绕 **"学 → 记 → 练 → 悟"** 学习闭环,提供四大模块:
26+
27+
### 🍅 番茄钟 — 时间管理
28+
29+
- 三段式计时:工作 / 短休息 / 长休息自动轮转
30+
- 双模式切换:上课模式(45 分钟)与自习模式(25/5 标准节奏)
31+
- 后台不中断,切换页面计时继续运行
32+
- 专注时长统计与趋势分析,量化学习投入
33+
34+
### 📝 智能笔记 — 知识沉淀
35+
36+
- 专业富文本编辑体验,支持多种排版
37+
- 多种模板:大纲式、康奈尔笔记法、自由画布等
38+
- 3 级嵌套文件夹 + 自由标签系统,灵活组织笔记
39+
- 本地全文搜索,自动保存,数据不丢失
40+
41+
### 🃏 闪卡 — 记忆巩固
42+
43+
- 基于间隔重复算法的科学记忆系统
44+
- 3 级嵌套牌组:科目 → 章节 → 知识点
45+
- 复习统计与遗忘曲线可视化
46+
- 支持 CSV / JSON 批量导入
47+
48+
### 🧠 费曼学习法 — 深度理解
49+
50+
- 四步引导:选概念 → 用自己的话解释 → 识别薄弱点 → 简化重述
51+
- 自动标记与汇总薄弱知识点
52+
- 1–5 星理解度评估,直观衡量掌握程度
53+
54+
### 🤖 AI 增强(联网可选)
55+
56+
| 能力 | 说明 |
57+
|------|------|
58+
| 笔记智能摘要 | 一键生成课堂笔记摘要与续写润色 |
59+
| AI 自动生成闪卡 | 从笔记内容智能生成记忆卡片 |
60+
| 费曼学习评估 | AI 评估解释质量,给出改进建议 |
61+
| 智能时长推荐 | 根据学习数据推荐最佳番茄钟时长 |
62+
63+
---
64+
65+
## 🚀 快速开始
66+
67+
### 环境要求
68+
69+
- **Node.js** 18+
70+
- **npm** 9+
71+
72+
### 安装与运行
73+
74+
```bash
75+
# 克隆仓库
76+
git clone https://github.com/Aparencia/KeBan.git
77+
cd KeBan
78+
79+
# 安装依赖
80+
cd client
81+
npm install
82+
83+
# 启动开发服务器
84+
npm run dev
85+
```
86+
87+
### 构建桌面安装包
88+
89+
```bash
90+
cd client
91+
npm run electron:build
92+
```
93+
94+
构建产物位于 `client/release/` 目录。
95+
96+
---
97+
98+
## 📁 项目结构
99+
100+
```
101+
KeBan/
102+
├── client/ # 前端客户端(桌面应用)
103+
├── server/ # 后端服务(AI 网关 + 数据同步)
104+
├── docs/ # 项目文档(按阶段组织)
105+
├── scripts/ # 脚本工具
106+
├── .env.example # 环境变量模板
107+
└── README.md
108+
```
109+
110+
| 目录 | 说明 |
111+
|------|------|
112+
| `client/` | 前端应用与 Electron 桌面端,包含所有 UI 和业务逻辑 |
113+
| `server/` | 后端微服务,包括 AI 增强网关和数据同步服务 |
114+
| `docs/` | 按项目生命周期组织的开发文档(phase0 ~ phase3) |
115+
| `scripts/` | 构建、部署等辅助脚本 |
116+
117+
---
118+
119+
## 🗺️ 路线图
120+
121+
| 阶段 | 状态 | 核心交付 |
122+
|------|------|----------|
123+
| **MVP-1 Alpha** | ✅ 已完成 | 纯本地核心版 — 四大模块 + 离线支持 + 本地存储 |
124+
| **MVP-2 Alpha** | 🔧 进行中 | AI 增强 + 云同步 + 桌面端 + 用户认证 |
125+
| **Beta 公测** | 📋 规划中 | 全功能集成,面向真实用户测试 |
126+
| **正式上线** | 🎯 规划中 | 生产就绪版 |
127+
128+
---
129+
130+
## 👥 贡献指南
131+
132+
### 提交规范
133+
134+
项目使用 **Conventional Commits** 规范,格式如下:
135+
136+
```
137+
<type>(<scope>): <description>
138+
```
139+
140+
**常用类型:**
141+
142+
| 类型 | 说明 |
143+
|------|------|
144+
| `feat` | 新功能 |
145+
| `fix` | 缺陷修复 |
146+
| `refactor` | 重构(不新增功能、不修复缺陷) |
147+
| `docs` | 文档变更 |
148+
| `style` | 代码格式调整 |
149+
| `test` | 测试相关 |
150+
| `chore` | 构建或工具变更 |
151+
| `perf` | 性能优化 |
152+
153+
**示例:**
154+
155+
```
156+
feat(notes): 添加康奈尔笔记模板
157+
fix(pomodoro): 修复切换标签页后计时器暂停的问题
158+
docs: 更新 README 快速开始章节
159+
```
160+
161+
### 代码质量
162+
163+
提交前请确保以下检查全部通过:
164+
165+
```bash
166+
npm run lint # 代码检查
167+
npm run test # 单元测试
168+
npm run build # 构建验证
169+
```
170+
171+
---
172+
173+
## 📄 许可证
174+
175+
**Private — All Rights Reserved.**
176+
177+
本项目为私有项目,所有权利保留。未经书面许可,不得复制、修改或分发本项目的任何部分。
1178
<p align="center">
2179
<h1 align="center">📚 课伴 KeBan</h1>
3180
<p align="center"><strong>你的 AI 智能学习伙伴 — 让每一分钟网课都高效有价值</strong></p>

0 commit comments

Comments
 (0)