Skip to content
hunterhan888Public

About

面向中文母语者的英文阅读学习工具。双击查词、生词本管理。

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Read-Ease

🎯 面向中文母语者的英文阅读学习 Web 应用
✨ A VibeCoding Project - AI辅助开发,人类指导设计


📖 项目简介

Read-Ease 是一款专为中文母语者设计的英文阅读辅助工具,通过智能标注、AI 释义等功能,让英文阅读更轻松、更高效。

核心特性

基础功能(无需 API Key)

  • ✅ 文章导入与管理 - 粘贴任意英文文章,自动分段处理
  • ✅ 智能生词标注 - 双击单词标记,拖拽选择词组
  • ✅ 词形归一化 - 自动识别单词原型(如 running → run)
  • ✅ 生词本管理 - 按字母排序或时间排序,支持搜索过滤
  • ✅ 语境追踪 - 每个生词关联最多 5 篇文章的使用场景

AI 增强功能(需配置 LLM API Key,暂时只支持DeepSeek)

  • 🤖 智能标题生成 - 自动为导入的文章生成中文标题
  • 🤖 AI 生词释义 - 基于上下文生成精准的中英文释义
  • 🤖 语境用法说明 - 解释单词在当前文章中的具体含义

截图预览

阅读视图 生词本

🚀 快速开始

方式 1:Docker 部署(推荐)

一键启动

# 克隆项目
git clone https://github.com/hunterhan888/read-ease.git
cd read-ease

# 启动服务
docker compose up -d

# 访问应用(浏览器打开 http://localhost:5110)

查看日志

docker compose logs -f

停止服务

docker compose down

方式 2:本地开发

前置要求

  • Node.js 18+
  • npm

安装步骤

# 安装依赖
npm install

# 配置环境变量(可选)
cp .env.example .env

# 启动开发服务器
npm start

访问 http://localhost:5110


🔧 配置 AI 功能(可选)

Read-Ease 的基础功能无需任何配置即可使用。如果你想启用 AI 增强功能:

1. 获取 DeepSeek API Key

访问 DeepSeek 官网 注册并获取 API Key

2. 配置环境变量

Docker 方式:

# 编辑 .env 文件
nano .env

# 添加以下内容
DEEPSEEK_API_KEY=你的API_KEY

本地方式:

cp .env.example .env
# 编辑 .env 文件填写 API Key

3. 重启应用

docker compose restart  # Docker 方式
# 或直接重启 npm start

🎨 使用指南

1. 导入文章

  1. 点击「导入文章」按钮
  2. 粘贴任意英文文章内容
  3. 点击「导入」

提示:

  • 如果配置了 API Key,系统会自动生成中文标题
  • 未配置则使用文章前 30 个字符作为标题

2. 标记生词

单词标记:双击任意单词
词组标记:鼠标拖拽选择多个单词

智能特性:

  • 自动词形归一化(复数、过去式等 → 原型)
  • 同一单词在不同文章中的用法分别记录
  • 已标记的词会高亮显示

3. 查看生词本

  1. 点击导航栏「生词表」
  2. 支持以下功能:
    • 按字母 A-Z 排序
    • 按最近标记时间排序
    • 实时搜索过滤
    • 展开/收起释义

4. AI 释义(需 API Key)

标记生词后,系统会自动:

  • 生成基础释义(中英文对照)
  • 分析当前语境下的具体用法
  • 关联到相关文章的语境

自定义端口

Docker 方式

编辑 .env 文件:

PORT=3000           # 容器内端口
HOST_PORT=8080      # 映射到主机的端口

重启:

docker compose up -d --build

本地方式

PORT=3000 npm start

📊 数据管理

数据持久化

所有用户数据存储在 data/ 目录:

  • articles.json - 文章内容、标记
  • vocabulary.json - 生词列表、释义
  • config.json - 用户配置

Docker 部署:通过 Volume 映射,容器重启数据不丢失

数据备份

# 备份
tar -czf backup-$(date +%Y%m%d).tar.gz data/

# 恢复
tar -xzf backup-20260627.tar.gz

📜 许可证

MIT License


🎉 致谢

这是一个 VibeCoding 项目

本项目由人类指导设计, AI 辅助开发。展示了人机协作在软件开发中的可能性:

  • 👨‍💻 人类贡献:需求定义、功能取舍、用户体验优化
  • 🤖 AI 贡献:代码实现、架构设计、问题解决

VibeCoding 理念:让 AI 处理繁琐的编码细节,让人类专注于创造性思考和产品方向。


Made with ❤️ by VibeCoding
让英文阅读更轻松,让学习更高效

About

面向中文母语者的英文阅读学习工具。双击查词、生词本管理。

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages