Stev_Wang
04f49690f4
ci / 质量门禁 (push) Canceled after 0s
- 建立 pnpm workspace + Turborepo 单仓、ESLint 9/Prettier/commitlint/husky 门禁 - NestJS + Fastify API：统一错误体、trace_id、Zod 管道、/health 真实依赖探活、OpenAPI 3.1 契约 - Prisma 基线：outbox_events/idempotency_keys/system_configs 与首版迁移、幂等种子 - shared 契约包：错误码、权限点、ULID、游标分页、命名/时间工具 - ui 包与 Web 壳层：Semi + Remix 图标统一出口、Cloud Blue 视觉、登录/工作台/错误页 - worker 骨架、Playwright 冒烟、Gitea CI、OpenAPI 快照与 oasdiff 回退脚本 - 补充 A0 实施报告与本地开发说明
104 lines
7.6 KiB
Markdown
104 lines
7.6 KiB
Markdown
# 灵犀 · 信息流广告素材一站式生产平台
|
||
|
||
面向信息流广告投放的素材生产平台：**行业包 → 要素卡 → 脚本 → 素材 → 快筛 → 导出即归档**。
|
||
|
||
- **图片线**：确定性批量流水线（PSD 模板套版 + 自动抠图 + 多规格合成），不做 AI 生图。
|
||
- **视频线**：AI 逐镜图生视频（关键帧 → 单镜 → 拼接 → 校验）。
|
||
- **内核不分行业**：电商、金融等差异收敛为可配置**行业包**，新行业只换配置、不发版。
|
||
|
||
---
|
||
|
||
## 文档索引
|
||
|
||
| 文档 | 路径 | 版本 | 作用 |
|
||
| ------------ | ------------------------------------------------------------------------------------------------------ | -------------------- | ---------------------------------------------------------------------- |
|
||
| **项目总纲** | [AGENTS.md](AGENTS.md) | V1.0 | 硬约束、技术栈、仓库结构、命令契约、流程 |
|
||
| **PRD** | [灵犀-信息流广告素材一站式生产平台PRD.md](docs/PRD/灵犀-信息流广告素材一站式生产平台PRD.md) | **V1.6（最新）** | 需求、业务规则（R-01~R-30）、验收标准 |
|
||
| **技术架构** | [灵犀_信息流素材生产平台_技术架构_V0.1.md](docs/技术架构/灵犀_信息流素材生产平台_技术架构_V0.1.md) | **V0.4（内部版本）** | 技术选型、分层模块、数据模型、接口、ADR |
|
||
| **开发计划** | [灵犀_信息流素材生产平台_开发计划_V0.1.md](docs/开发计划/灵犀_信息流素材生产平台_开发计划_V0.1.md) | **V0.1（初稿）** | 全项目 M0–M4：里程碑、批次、WBS、七管理模块专项、门禁、风险、验收 |
|
||
| 立项建议 | [灵犀_信息流素材生产平台_立项建议书_V0.1.md](docs/立项建议/灵犀_信息流素材生产平台_立项建议书_V0.1.md) | V0.1 | 背景、目标、投入产出论证（不约束实现） |
|
||
| **工程规范** | [docs/工程规范/](docs/工程规范/README.md) | V1.0 | Git、代码风格、格式化、API、数据库、测试、Review、日志、密钥、资产命名 |
|
||
| **A0 报告** | [灵犀_A0工程骨架与契约基线_实施报告_V0.1.md](docs/开发计划/灵犀_A0工程骨架与契约基线_实施报告_V0.1.md) | V0.1 | A0 完成范围、门禁实测、环境适配与待确认事项 |
|
||
| 历史 PRD | `docs/PRD/灵犀_信息流素材生产平台_PRD_V0.1~V0.3.md` | 归档 | 仅作沿革参考，**不具约束力** |
|
||
|
||
> 阅读顺序：`AGENTS.md` → PRD §1/§6 → 技术架构 §0.2/§3 → 按任务查 `docs/工程规范/`。
|
||
|
||
---
|
||
|
||
## 核心链路（五步）
|
||
|
||
| 步骤 | 动作 | 产出 |
|
||
| ---- | ---------------------------------------------- | -------------------- |
|
||
| 1 | 建行业 / 客户信息，选行业包并套客户资产包 | 归属根节点就绪 |
|
||
| 2 | 要素卡 + 卖点库 → 脚本生成 / 校核 / 审核入库 | 已入库脚本（带编号） |
|
||
| 3 | 图片批次（模板 × 商品图 × 规格）/ 视频逐镜生成 | 候选素材 |
|
||
| 4 | 按组并排快筛，勾选保留项 | 待导出素材 |
|
||
| 5 | 导出（固定目录 + 命名规则）+ 自动归档 | 可投素材 + 交付清单 |
|
||
|
||
---
|
||
|
||
## 功能模块（PRD V1.6）
|
||
|
||
| 模块 | 定位 |
|
||
| ------------ | ------------------------------------------------------------------------ |
|
||
| **脚本** | 要素卡 / 卖点库 / 模板 / 生成 / 质量校核 / 审核入库 / 版本 |
|
||
| **素材** | 图片线（PSD 套版、抠图、规格矩阵）、视频线（逐镜生成、变体）、快筛与预览 |
|
||
| **资产** | 15 类资产的库、版本、引用、复审与复用度量 |
|
||
| **平台管理** | 组织账号、客户、角色权限、AI 配置、数据字典、审计、行业包与表单设计器 |
|
||
|
||
> 早期文档中的「四大模块（脚本生成 / 素材生产 / 编辑 / 管理）」已于 PRD V1.6 重构为「脚本 / 素材 / 资产 / 平台管理」三主线 + 一底座。
|
||
|
||
---
|
||
|
||
## 目录结构（目标态）
|
||
|
||
```
|
||
apps/api NestJS HTTP + SSE + AI 回调
|
||
apps/worker 异步任务（图片 / 视频 / 导出 / 入库）
|
||
apps/web React SPA
|
||
packages/ shared · form-engine · render · ai-sdk · ui
|
||
prisma/ 数据模型与迁移
|
||
infra/ compose、Nginx、监控、备份
|
||
docs/ PRD / 技术架构 / 开发计划 / 立项建议 / 工程规范
|
||
```
|
||
|
||
当前已完成 **A0 工程骨架与契约基线**（monorepo、API/Worker/Web 骨架、Prisma 平台表、shared 契约包、UI 包、布局与登录壳、CI 与冒烟测试）；业务模块从 A1 起按开发计划推进。目录与依赖方向见 [AGENTS.md §5](AGENTS.md)。
|
||
|
||
---
|
||
|
||
## 本地开发
|
||
|
||
前置：Node.js `24.15.0`（`.nvmrc`）、pnpm `10.x`、Docker。
|
||
|
||
```bash
|
||
cp .env.example .env.local
|
||
cp .env.local .env # Prisma CLI 只读取 .env（两者均已 gitignore）
|
||
pnpm compose:up # PostgreSQL 18 / Redis 7.4 / S3 兼容存储
|
||
pnpm db:migrate # 首次建表；后续由 Prisma 迁移管理
|
||
pnpm db:seed # 幂等写入 system_configs 基线
|
||
pnpm dev # 并行启动 api(3000) / web(5173) / worker
|
||
```
|
||
|
||
- **端口**：为避免与本机已有容器冲突，compose 宿主端口为 PostgreSQL `15432`、Redis `16379`、S3 `19000/19001`，容器内仍是 `5432/6379/9000/9001`；`.env.example` 已按宿主端口给出连接串。
|
||
- **对象存储**：当前 Docker 环境拉取不到 `minio/minio` 镜像（registry denied、二进制 410），A0 的 compose 使用 `adobe/s3mock` 并提供 `assets / renders / temp / archive` 四个初始桶；CI 或生产接入真实 MinIO 时只需替换 `infra/docker-compose.dev.yaml` 的 `s3` 服务。
|
||
- **API 文档**：启动 api 后访问 `http://127.0.0.1:3000/api/docs`，OpenAPI JSON 在 `openapi/lingxi.openapi.json`。
|
||
- **演示登录**：A0 尚未接鉴权（A1 实现），`VITE_PUBLIC_DEMO_SESSION=true` 时登录页使用本地演示会话进入工作台；A1 接入真实登录后删除。
|
||
|
||
常用校验：
|
||
|
||
```bash
|
||
pnpm lint && pnpm typecheck && pnpm test # 本地门禁
|
||
pnpm build && pnpm test:e2e # 构建与端到端冒烟
|
||
pnpm openapi:export && pnpm openapi:diff # 契约快照与破坏性变更检查
|
||
```
|
||
|
||
命令与门禁见 [AGENTS.md §6](AGENTS.md) 与 [06-测试与CI规范](docs/工程规范/06-测试与CI规范.md)。当前 UI 采用「顶部模块菜单 + 左侧功能菜单」布局，视觉方向为 **A · 云白蓝（传统企业后台 + 现代浅色质感）**。
|
||
|
||
---
|
||
|
||
## 约定速查
|
||
|
||
- 包管理只用 **pnpm**，Node 锁定 **24.15.0**；UI 只用 **Semi Design**，图标只用 **Remix Icon**。
|
||
- 客户数据隔离、审计 append-only、导出全留痕、阈值单一来源、低质量不可静默——均为硬约束。
|
||
- 完整红线见 [AGENTS.md §3](AGENTS.md)。
|