Qwerty Learner 技术文档

1. 安装指南

环境准备

• NodeJS (推荐最新LTS版本)
• Git (版本控制工具)
• Yarn (包管理工具)

验证环境

node --version
git --version
yarn --version

手动安装步骤

1. 克隆项目仓库：

git clone https://github.com/RealKai42/qwerty-learner.git

2. 进入项目目录：

cd qwerty-learner

3. 安装依赖：

yarn install

4. 启动开发服务器：

yarn start

5. 访问应用： 浏览器打开 http://localhost:5173/

脚本安装

• Windows用户： 执行 scripts/install.ps1

• MacOS用户： 执行 scripts/install.sh

2. 使用说明

主要功能

1. 词库选择：

   • 内置多种英语考试词库（CET-4/6、GRE、TOEFL等）
   • 程序员专用词库（常用单词、API等）
   • 多语言支持（日语、哈萨克语等）

2. 练习模式：

   • 实时显示输入速度和正确率
   • 错误单词需重新输入确保正确记忆
   • 章节完成后可选择默写模式巩固记忆

3. 辅助功能：

   • 音标显示与发音功能
   • 速度统计与历史记录

操作指南

1. 从首页选择适合的词库
2. 开始输入显示的单词
3. 完成章节后可选择默写测试
4. 查看统计面板了解进步情况

3. API使用文档

核心API

1. 词库管理：

   • 获取可用词库列表
   • 加载特定词库数据
   • 自定义词库导入

2. 练习控制：

   • 开始/暂停练习
   • 重置当前进度
   • 切换练习模式

3. 数据统计：

   • 获取输入速度数据
   • 查询正确率历史
   • 导出练习记录

扩展API

1. 语音服务：

   • 单词发音控制
   • 语音速率调整

2. 用户设置：

   • 界面主题配置
   • 键盘布局设置
   • 练习难度调整

4. 项目安装方式

本地开发安装

1. 克隆仓库
2. 安装依赖
3. 启动开发服务器

生产环境部署

1. Vercel部署：

   • 使用官方部署按钮一键部署
   • 设置Output Directory为"build"

2. Docker部署：

   docker build -t qwerty-learner .
   docker run -p 3000:3000 qwerty-learner
   

3. 静态文件部署：

   • 执行构建命令：

     yarn build
     

   • 部署build目录到Web服务器

扩展安装

1. VSCode插件版：

   • 通过VSCode插件市场安装
   • 支持一键启动练习

2. 桌面应用：

   • 使用Electron打包
   • 提供独立安装包