Skip to content

开发环境搭建

环境配置和工具

项目由多个独立仓库组成:genshin-novel-reader-web 是 React 阅读器;genshin-novel-reader-api-node 是主业务 API 和 Web 页面;genshin-novel-reader-api-python 提供标签生成;genshin-novel-reader-scripts 统一管理本地数据库、配置生成和后端初始化。在线阅读器主要使用 Node API;Python 服务由 Node 定时任务调用。

离线前端开发

需要 Node.js/npm 和 Git。在 genshin-novel-reader-web 仓库中执行:

npm install
npm run dev

Vite 会输出本地开发地址。此模式可用于开发阅读器 UI 和离线功能;在线功能还需 Node API、MariaDB、Redis 和 Python 标签服务。

构建 npm 包使用 npm run build。npm run local-build 会构建并复制产物到相邻的 Node API 仓库,供服务端页面集成使用。

在线后端开发环境

需要 Git、Docker Compose v2、Node.js/npm、Python 3 和 pip。将 genshin-novel-reader-scripts 克隆到工作区,和 Web、Node API、Python API 仓库并列,然后运行:

bash scripts/init.sh

初始化脚本会创建 .env(若不存在)、克隆缺少的 Node 和 Python API 仓库,生成 Node 配置并安装依赖。检查 genshin-novel-reader-scripts/.env 后启动共享 MariaDB 和 Redis:

docker compose up -d

Node API 和 Python API 在各自仓库启动。Python 服务也可以由 scripts 仓库提供的脚本启动:

bash scripts/start-python-api.sh

Python API 默认监听 127.0.0.1:5000,Node 通过 PYTHON_API_URL(默认 http://127.0.0.1:5000)访问它。Node 默认监听 PORT 或 8081。各仓库 README 和 .env.example 是命令、端口及环境变量的最终依据。

数据库初始化和管理员

MariaDB 数据存储在 scripts 仓库的 data/mysql/。空数据目录首次启动时自动执行 sql/init.sql;已有数据目录不会再次初始化。当前脚本提供的是全新数据库初始化,不是历史 schema migration。不要为了升级直接删除已有数据目录;操作前必须备份。

管理员账号需在 Node API 使用 scrypt 密码哈希创建,并将 user.role 设为 admin。创建步骤见 scripts 仓库 README。生产环境必须设置安全的 JWT_SECRET,不可使用开发默认值。浏览器登录页会将 token 和用户名写入 novelToken、username Cookie,退出页面清除这两个 Cookie。

主要技术

  • 阅读器:React 18、Ant Design 5、Vite、Less、Axios。
  • 主 API/Web:Node.js、Express、EJS、MariaDB/MySQL、Redis、JWT。
  • 标签服务:Python、Flask、jieba。
  • 本地开发依赖:Docker Compose 管理 MariaDB 和 Redis。