Files
lingxi/README.md
T
Stev_Wang c50ee7b57a docs(repo): rewrite README to current product baseline
原 README 仍指向 PRD V0.3 与已废弃的「四大模块」。改为三主线 + 一底座,
补齐文档索引、目标目录结构与本地开发入口。

影响面:仅文档,无代码影响。回滚方式:git revert 本提交。
2026-11-02 15:09:51 +08:00

85 lines
4.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 灵犀 · 信息流广告素材一站式生产平台
面向信息流广告投放的素材生产平台:**行业包 → 要素卡 → 脚本 → 素材 → 快筛 → 导出即归档**。
- **图片线**:确定性批量流水线(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 | 背景、目标、投入产出论证(不约束实现) |
| **工程规范** | [docs/工程规范/](docs/工程规范/README.md) | V1.0 | Git、代码风格、格式化、API、数据库、测试、Review、日志、密钥、资产命名 |
| 历史 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 / 技术架构 / 立项建议 / 工程规范
```
当前仓库处于**规范与设计阶段**,尚未建代码;建仓必须遵循 [AGENTS.md §5](AGENTS.md) 的结构与依赖方向。
---
## 本地开发(建仓后适用)
```bash
cp .env.example .env.local
pnpm compose:up # PostgreSQL 18 / Redis 7.4 / MinIO
pnpm db:migrate
pnpm dev
```
命令与门禁见 [AGENTS.md §6](AGENTS.md) 与 [06-测试与CI规范](docs/工程规范/06-测试与CI规范.md)。
---
## 约定速查
- 包管理只用 **pnpm**,Node 锁定 **24.15.0**;UI 只用 **Semi Design**,图标只用 **Remix Icon**。
- 客户数据隔离、审计 append-only、导出全留痕、阈值单一来源、低质量不可静默——均为硬约束。
- 完整红线见 [AGENTS.md §3](AGENTS.md)。