Skip to content

QUICKSTART.md

Latest commit

 

History

History
277 lines (191 loc) · 5.42 KB

QUICKSTART.md

File metadata and controls

277 lines (191 loc) · 5.42 KB
Raw

Papyrus 快速启动指南

🚀 5分钟上手

环境要求

组件 版本要求
Node.js 24+
npm 11+

步骤 1：安装依赖

在项目根目录执行：

npm install

postinstall 会自动级联安装 frontend/ 和 backend/ 的依赖。

如需单独安装：

cd frontend && npm install
cd ../backend && npm install

步骤 2：启动程序

方式 1：同时启动前后端（推荐开发）

npm run dev

这会并发启动：

访问 http://localhost:5173 查看应用。

方式 2：带 Electron 桌面壳

npm run electron:dev

方式 3：分别启动（调试）

# 终端 1：启动后端
cd backend && npm run dev

# 终端 2：启动前端
cd frontend && npm run dev

📝 基础使用

添加卡片

  1. 点击侧边栏 "卷轴" 进入复习页面
  2. 点击 "添加新卷轴" 按钮
  3. 输入题目和答案
  4. 点击保存

批量导入

  1. 准备 UTF-8 .txt 文件，格式：问题 === 答案
  2. 在卷轴页面点击导入按钮
  3. 选择文件并确认

卡片组之间用 === 分隔，组间空一行提高可读性。

复习卡片

  • Space: 显示答案
  • 1: 忘记（卡片很快返回）
  • 2: 模糊（正常间隔）
  • 3: 秒杀（间隔线性增长）

🤖 AI 功能配置

方式 1：使用 OpenAI

  1. 获取 API Key：https://platform.openai.com/api-keys
  2. 进入设置页面 → AI 配置
  3. 选择提供商并输入 API Key
  4. 在模型管理中选择模型（如 gpt-4o）
  5. 保存设置

方式 2：使用 Ollama（免费本地）

  1. 安装 Ollama：https://ollama.ai
  2. 拉取模型： 
    ollama pull qwen:0.5b  # 小模型，快速
# 或
ollama pull llama3     # 更强大
  3. 在 Papyrus 中：
    • 提供商选择：ollama
    • 模型管理：添加模型名称（如 qwen:0.5b）
  4. 保存设置

方式 3：使用自定义 API

如果你有其他兼容 OpenAI API 的服务：

  1. 提供商选择：custom
  2. 输入 API Key 和 Base URL
  3. 添加模型名称
  4. 保存设置

💬 AI 对话示例

学习辅助

你：帮我解释这道题
AI：[根据当前卡片内容给出解释]

你：给我一个提示，不要直接告诉答案
AI：[给出启发性提示]

你：这个知识点还有什么相关的内容？
AI：[扩展相关知识]

卡片管理

你：帮我创建一张关于 Python 装饰器的卡片
AI：[生成工具调用，创建卡片]

你：搜索所有关于递归的卡片
AI：[搜索并列出结果]

你：给我看看学习统计
AI：[显示统计信息]

⚙️ 常用设置

调整 AI 参数

在设置 → AI 配置：

  • Temperature（创造性）

    • 0.3：精确、保守
    • 0.7：平衡（推荐）
    • 1.2：创意、发散

  • Max Tokens（回复长度）

    • 500：简短回答
    • 2000：详细解释（推荐）
    • 4000：长篇内容

管理模型

在设置 → 模型管理：

  • ➕ 添加：手动添加模型名称
  • ✏️ 编辑：修改模型名称
  • 🗑️ 删除：删除不需要的模型
  • 🔄 从API刷新：自动获取可用模型列表

无障碍设置

在设置 → 无障碍：

  • 减少动画：减弱界面动画
  • 高对比度：增强文字对比度
  • 屏幕阅读器优化：优化 ARIA 标签
  • 焦点指示器：始终显示键盘焦点
  • 大光标：放大鼠标指针

📊 学习技巧

SM-2 算法最佳实践

  1. 诚实评分：不要高估自己的记忆
  2. 及时复习：看到待复习提示就复习
  3. 理解优先：不要死记硬背
  4. 适量学习：每天 20-30 张新卡片

AI 辅助学习

  1. 主动提问：不懂就问，AI 会根据上下文回答
  2. 要求提示：让 AI 给提示而不是答案
  3. 深入探索：追问相关知识点
  4. 生成练习：让 AI 生成变式题

🔧 故障排除

AI 功能不可用

问题：聊天面板无法使用

解决：

  1. 检查后端是否运行：curl http://127.0.0.1:8000/api/health
  2. 检查 AI 配置是否完整（提供商、模型、API Key）
  3. 查看后端日志：$HOME/PapyrusData/logs/
  4. 重启前后端服务

API 调用失败

问题：显示 "错误: API调用失败"

解决：

  1. 检查 API Key 是否正确
  2. 检查网络连接
  3. 确认 API 额度是否充足
  4. 尝试切换模型

Ollama 连接失败

问题："Ollama调用失败"

解决：

  1. 确认 Ollama 服务运行：ollama serve
  2. 检查端口：默认 11434
  3. 确认模型已下载：ollama list

后端启动失败

解决：

cd backend
rm -rf node_modules
npm install
npm run dev

前端启动失败

解决：

cd frontend
rm -rf node_modules package-lock.json
npm install
npm run dev

📚 更多资源

💡 小贴士

  1. 数据备份：主库为 $HOME/PapyrusData/papyrus.db（SQLite）；可通过 POST /api/backup 或应用内导出备份
  2. 快捷键：全程键盘操作，提高效率
  3. 本地优先：使用 Ollama 可完全离线使用
  4. 隐私保护：API Key 加密存储，数据本地 SQLite 存储

开始你的高效学习之旅吧！🎉