npm 源码方式部署 Kikoeru:适合开发者和深度定制
适合谁
- 有 Node.js 环境(建议 18+)
- 想自己改代码、二次开发
- 需要嵌入式部署或集成到其他系统
方式一:npm 包快速安装
# 确保有 Node.js 18+ 和 npm
node -v
npm -v
# 安装后端
npm install kikoeru-express
# 下载或构建前端 dist/ 目录放到项目根目录
# 然后启动
npm start
启动后 Express 监听 http://[::]:8888。
方式二:源码克隆构建
# 克隆后端
git clone https://github.com/kikoeru-project/kikoeru-express.git
cd kikoeru-express
# 安装依赖
npm install
# 构建前端(可选,也可以单独 clone kikoeru-quasar 构建后复制 dist/)
# 前端仓库:https://github.com/kikoeru-project/kikoeru-quasar
# 前端构建后把 dist/ 复制到后端根目录
# 启动开发模式(会实时扫描文件变动)
npm run dev
# 启动生产模式
npm start
前端构建(如果你想自己改 UI)
git clone https://github.com/kikoeru-project/kikoeru-quasar.git
cd kikoeru-quasar
npm install
npm run build:pwa # 或 build:spa
# 构建产物在 dist/,复制到 kikoeru-express 的根目录
项目结构说明
后端源码目录的主要文件:
| 文件/目录 | 作用 |
|---|---|
| app.js | 入口文件 |
| api.js | 注册 Express 路由和 JWT 中间件 |
| config.js | 配置文件读写和版本升级锁 |
| socket.js | Socket.io 初始化(扫描进度推送) |
| routes/ | 主要 API 路由 |
| database/ | 数据库操作 |
| filesystem/ | 文件扫描相关 |
| scraper/ | DLSite 爬虫 |
| config/ | 运行时 config.json |
| sqlite/ | SQLite 数据库(运行时生成) |
| dist/ | 前端 PWA 静态文件 |
数据存储说明
npm 包方式的 SQLite、封面、配置文件都在运行时工作目录下生成——和 docker-compose 不同,这里没有容器帮你隔离。建议建一个固定的数据目录,用绝对路径指定:
# 先 cd 到数据目录再运行
cd /data/kikoeru
node /path/to/kikoeru-express/app.js
或者设置环境变量(具体变量名参考源码)。
升级源码版
cd kikoeru-express
git pull
npm install # 依赖可能有变化
npm run build # 如果有构建步骤
npm start