InkOS Web

InkOS 核心工作流的 Web 化创作工作台
把 shared draft、写作、审计、修订、重写、truth files 与 admin / owner 管理面板整合进一个可本地部署的 Studio 风格界面。

---

为什么是这个项目

inkos-web 不是一个“套了个壳的普通 CRUD 后台”，也不是一个“做做样子的 AI 小说 UI”。

它的目标是：

• 对齐 InkOS upstream 工作流语义，而不是自己脑补一套假的 agent 流程
• 把 CLI / core 的真实写作链路搬进 Web，让 draft / audit / revise / rewrite / resync 可视化可操作
• 支持本地部署和继续二开，方便你在此基础上继续做创作平台、内部工作台或演示环境

当前仓库已接入并可运行的关键链路包括：

• shared draft 建书
• write-next 写下一章
• draft 仅生成草稿
• audit 审计章节
• revise 多模式修订
• rewrite 整章重写
• resync 手工编辑正文后回写 truth/state
• admin / owner 面板集中管理 LLM 接口配置

---

截图预览

Dashboard / 创作总览

Shared Draft / 对话建书

Chapter Reader / 章节工作台

---

功能亮点

模块	说明
Shared Draft	先通过对话收敛书名、题材、世界观、主角与冲突，再按当前草稿一键建书
Books / Dashboard	书架、创作总览、快捷动作、实时工作流事件、快速写下一章
Chapter Reader	阅读正文、编辑正文、审计、修订、同步 truth、整章重写
Truth Files	查看 / 编辑 story bible、volume outline、current state 等核心文件
Analytics	章节、字数、状态分布等基础分析视图
SSE Event Stream	实时接收 write / draft / audit / revise / rewrite / resync 流程状态
Admin / Owner	用户、书籍、套餐、管理员与 LLM 接口集中管理
Local Scripts	Windows 一键启动 / 停止，适合本地演示和持续开发

---

技术架构

flowchart LR
    U["Browser / Studio UI"] --> C["React + Vite Client"]
    C --> A["Hono API Server"]
    C --> E["SSE /api/events"]

    A --> DB["SQLite + Drizzle ORM"]
    A --> CORE["packages/inkos-core"]
    A --> AUTH["JWT Auth"]

    CORE --> PIPE["write / draft / audit / revise / rewrite / resync"]
    CORE --> STATE["truth files / state sync"]
    CORE --> LLM["LLM Provider Routing"]

    A --> ADMIN["Admin / Owner APIs"]
    ADMIN --> CFG["LLM Configs / Users / Books"]

Loading

仓库结构

client/                 React 前端
server/                 Hono 后端
shared/                 前后端共享类型
packages/inkos-core/    接入的 InkOS 核心工作流
scripts/                本地启动 / 停止 / 辅助脚本
.github/                GitHub 社区文件、CI、截图资源

---

技术栈

前端

• React
• React Router
• TanStack Query
• Zustand
• Vite
• Lucide Icons

后端

• Hono
• Drizzle ORM
• SQLite / better-sqlite3
• JWT 鉴权

Workspace / Tooling

• pnpm workspace
• TypeScript
• packages/inkos-core（基于 upstream 对齐接入）

---

快速开始

1. 环境要求

• Node.js >= 20
• pnpm >= 9
• Windows 本地开发推荐直接使用仓库内脚本

2. 安装依赖

pnpm install

3. 配置环境变量

cp .env.example .env

至少需要根据你的环境调整：

• DATABASE_URL
• JWT_SECRET
• ENCRYPTION_KEY
• CORS_ORIGIN

4. 启动项目

方式 A：一键启动（推荐）

pnpm local:start

停止：

pnpm local:stop

默认本地地址：

• 前端：http://127.0.0.1:5173
• 后端：http://127.0.0.1:3001

方式 B：分别启动前后端

pnpm dev:server
pnpm dev:client

方式 C：同时启动

pnpm dev

5. 构建

pnpm --filter @actalk/inkos-core build
pnpm build

---

当前适合拿它做什么

你可以把这个仓库当成：

• InkOS Web 版 Studio 分支
• 小说创作工作台的二开基础仓库
• 本地部署演示环境
• 把 upstream 工作流继续往 SaaS / 团队协作产品演进的起点

---

与上游 InkOS 的关系

• 上游参考：Narcooo/inkos
• 当前仓库：qiyan233/inkos-web
• 这个仓库重点不是重复发明工作流，而是：
  • 对齐 upstream 语义
  • 接入 inkos-core
  • 提供 Web UI、管理面板、本地部署与后续扩展能力

如果你的改动涉及：

• 章节状态流转
• truth/state 同步
• revise / rewrite / resync 语义
• shared draft 建书行为

请优先对照 upstream 再改，避免重新做出一套“看起来像但实际上不是”的流程。

---

开源与协作

提 Issue / PR 前建议先看

• CONTRIBUTING.md
• SECURITY.md
• CODE_OF_CONDUCT.md

提交前最基本检查

pnpm --filter @actalk/inkos-core build
pnpm build

---

开源注意事项

本仓库已补充 GitHub 社区协作文件，包含：

• Issue 模板
• PR 模板
• CI 工作流
• CODEOWNERS
• Contributing / Security / Code of Conduct

如果你继续把它作为公开仓库维护，请注意：

1. 不要提交真实 API Key / JWT / 数据库凭据
2. README 中应持续说明和 upstream 的关系
3. 涉及 AGPL 许可的代码与分发需要审慎处理

---

Roadmap（建议方向）

• 更完整的 admin / owner 运维面板
• 更细粒度的 truth files diff / history
• 更完整的 analytics 指标与图表
• 更多 upstream Studio 页面细节对齐
• 部署文档（Docker / VPS / reverse proxy）
• 多用户 / 团队协作能力

---

许可证

本项目使用 GNU Affero General Public License v3.0 or later。