dls7788/easy-reader repository overview

⁠easyReader —— 自托管小说阅读平台

https://easyreader.ucool.uk/⁠

单容器部署，轻量级 NAS 小说阅读系统。

技术栈
后端：Node.js + Express + TypeScript + SQLite
前端：Vue 3 + Vite + TypeScript + Element Plus

⁠功能特性

• 多格式支持：TXT / PDF / EPUB，插件化架构，便于扩展
• 大文件优化：TXT 流式扫描，建立章节字节索引，按需读取单章，支持万章大书秒开
• AI 辅助管理：自动填充书名、作者、简介、分类，支持 6 家 AI 服务商
• 阅读进度同步：精确记录章节与滚动位置，重新打开自动还原
• 书签系统：按章节添加带备注的书签
• 邀请码注册：管理员生成邀请码，支持复制链接或 SMTP 邮件发送
• 多主题阅读器：白天 / 护眼 / 夜间 / 暗黑，字体、字号、行距全部可调

⁠快速启动

# 1. 克隆项目
git clone <repo-url>
cd easyReader

# 2. 配置环境变量
cp .env.example .env
# 编辑 .env，至少修改 JWT_SECRET

# 3. 准备书库目录（NAS 路径）
# 在 docker-compose.yml 的 volumes 中配置：
#   - /your/nas/books:/app/books
#   - ./data:/app/data

# 4. 启动
docker compose up -d --build

• 首次构建约需 3–5 分钟（编译 C++ 原生模块）
• 访问地址：http://localhost:8080

默认管理员账户

登录后进入书库页，点击「扫描书库」导入 books/ 目录中的文件。

⁠AI 插件

在「系统设置 → AI 设置」中选择服务商并填写 API Key：

• 推荐使用 DeepSeek（实测通过）
• 其他 AI 服务商虽有接口，但未实测

配置后，在书籍详情页点击「AI 填充」可自动识别元信息。