本地开发

开发模式适合改代码、调接口和验证交互。如果只是部署体验,请优先看“开始”里的 Docker Compose 快速部署。

推荐拓扑

日常开发推荐:

  • PostgreSQL、Redis 和 worker 用 docker-compose-dev.yaml
  • API 在宿主机运行,方便调试 Go 代码。
  • Web 在宿主机运行,享受 Vite 热更新。
docker compose -f docker-compose-dev.yaml up -d --build
go run ./cmd/api
pnpm --dir web install
pnpm --dir web dev

后端入口

  • cmd/api:HTTP API、Webhook、OAuth 回调、权限入口和任务投递。
  • cmd/worker:构建、部署、状态同步、证书申请和资源清理等异步任务。
  • internal/api:HTTP handler 和响应模型。
  • internal/model:GORM 数据模型。
  • internal/provider:Git、Registry、Kubernetes、DNS 等外部平台适配。
  • internal/worker:异步任务运行器。

Handler 只做参数解析、权限入口和响应;业务逻辑放 service;数据访问放 repository;外部系统调用放 provider。

前端入口

  • web/src/pages:页面级模块。
  • web/src/components/ui:shadcn/ui 基础组件。
  • web/src/components/common:跨页面业务组件。
  • web/src/api:API client 和 DTO 类型。
  • web/src/i18n:中英文文案。

共享模块必须使用 @/ 根目录导入。用户可见文案必须进入 i18n,不要直接写死在组件里。

文档站

docs/ 是 Rspress 文档站。新增功能、改动流程或调整用户体验时,需要同步更新这里的用户文档。