跳转到内容

开发文档

面向在 cikio 生态里写代码的人。本分区只承载对外可见的开发资料:结构、约定、命令与已知的坑。 各子项目的内部设计文档(如 ccu/DESIGN.md、forum/DESIGN.md)仍留在各自目录,不搬进来。

每个子项目一篇,统一覆盖:技术栈与版本、目录分层、本地开发、数据库迁移、构建与部署、必须遵守的约束。

cikio 的代码集中在一个 pnpm workspace 仓库 cikio-monorepo:

  • 文件夹cikio-monorepo/ (pnpm workspace 根)
    • 文件夹shared/ (共享包 @cikio/*)
      • 文件夹packages/
        • …
    • 文件夹authserver/ (统一认证中心)
      • …
    • 文件夹ccu/ (CCU 主站)
      • …
    • 文件夹message/ (消息中心)
      • …
    • 文件夹forum/ (社区站)
      • …
    • 文件夹docs/ (本站)
      • 文件夹content/
        • …
      • 文件夹src/
        • …
    • 文件夹dev-docs/ (仓库内部开发文档,不对外)
      • …
    • pnpm-workspace.yaml
    • package.json

各子项目保留自己的 package.json、wrangler.toml 与源码结构,可独立类型检查、构建与部署; dev-docs/ 是仓库内部的设计稿与迁移说明,不参与构建、不部署。

在仓库根目录执行:

终端窗口
pnpm install # 安装全部子项目依赖
pnpm typecheck # 递归对所有子项目做类型检查
pnpm build # 递归对所有子项目执行构建
pnpm --filter docs dev # 启动本站本地预览
pnpm --filter cikio-ccu run dev # 起某个子项目的开发服务器
pnpm --filter cikio-ccu run deploy # 部署某个子项目