# gen-poster

**Repository Path**: elfbobo_admin_admin/gen-poster

## Basic Information

- **Project Name**: gen-poster
- **Description**: gen-poster：一个专注于生成高质量海报的开源项目，提供多种模板和自定义选项，支持多平台使用，旨在为设计师和开发者带来便捷高效的创作体验。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-05-18
- **Last Updated**: 2026-05-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gen-poster

AI 驱动的海报创作工作台：对话生成 HTML + Tailwind 海报稿，经 DOM→Konva 转换后在可编辑画布上精修并导出。

## 文档

- [产品需求（PRD）](./docs/PRD.md)
- [技术方案（TECH）](./docs/TECH.md)
- [键盘快捷键](./docs/KEYBOARD.md)

## 环境要求

- Node.js ≥ 20
- pnpm ≥ 9

## 快速开始

```bash
pnpm install
pnpm build
cp apps/api/.env.example apps/api/.env
# 编辑 apps/api/.env 填入 MOONSHOT_API_KEY
pnpm dev
```

- Web：http://localhost:5173  
- API：http://localhost:3001  

未配置 API Key 时，API 返回演示用海报 JSX。

## Monorepo 结构

| 包 | 说明 |
|----|------|
| `@gen-poster/contracts` | Zod 契约与共享类型 |
| `@gen-poster/shared-config` | 常量与环境默认值 |
| `@gen-poster/html-to-konva` | DOM → Konva 数据（浏览器） |
| `@gen-poster/konva-editor` | 可独立发布的 Konva 编辑器 |
| `@types/gen-poster-*` | 各公共包的 TypeScript 声明包 |

## 第三方接入公共包

```bash
npm install @gen-poster/konva-editor @gen-poster/html-to-konva
npm install -D @types/gen-poster-konva-editor @types/gen-poster-html-to-konva
```

```tsx
import { KonvaEditor } from '@gen-poster/konva-editor';
import type { KonvaEditorProps } from '@types/gen-poster-konva-editor';
```

## 许可证

待定