diff --git a/README.md b/README.md index 85ec2a4..3ff3631 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,70 @@ # prompt-generator -🔥 Coding Agent 提示词润色工具 & 历史提示词复盘看板 \ No newline at end of file +🔥 Coding Agent 提示词构建 & 历史提示词复盘看板 + +## 功能特性 + +- **Prompt 构建器**:通过标签系统 + 片段模板快速组装高质量 Prompt +- **智能建议**:LLM 分析当前 Prompt,推荐补充约束 +- **历史复盘**:按项目/会话浏览历史 Prompt,支持文本/结构双视图 +- **CLAUDE.md 联动**:粘贴 CLAUDE.md 内容,LLM 对比分析缺失约束 +- **导出功能**:支持 Markdown / JSON / 纯文本导出 +- **亮色/暗色主题**:支持主题切换 + +## 快速开始 + +### 1. 配置环境变量 + +```bash +cp .env.example .env +# 编辑 .env 填写数据库和 LLM 配置 +``` + +### 2. Docker Compose 部署 + +```bash +docker compose up -d +``` + +### 3. 本地开发 + +```bash +# 需要 Go 1.22+ 和 MySQL 8.0 +go run . +``` + +访问 http://localhost:8080 + +## 技术栈 + +| 层 | 技术 | +|----|------| +| 前端 | HTML + Tailwind CSS CDN + 原生 JavaScript | +| 后端 | Go(标准库 net/http) | +| 数据库 | MySQL 8.0 | +| LLM | 兼容 OpenAI 接口(默认 DeepSeek) | +| 部署 | Docker Compose | + +## 环境变量 + +| 变量 | 说明 | 默认值 | +|------|------|--------| +| `SERVER_PORT` | 服务端口 | `8080` | +| `SESSION_SECRET` | Session 密钥 | - | +| `DB_HOST` | MySQL 地址 | `127.0.0.1` | +| `DB_PORT` | MySQL 端口 | `3306` | +| `DB_USER` | 数据库用户 | `root` | +| `DB_PASSWORD` | 数据库密码 | - | +| `DB_NAME` | 数据库名 | `prompt_generator` | +| `AUTH_PASSWORD` | 访问密码 | `admin` | +| `LLM_API_BASE_URL` | LLM API 地址 | `https://api.deepseek.com/v1` | +| `LLM_API_KEY` | LLM API Key | - | +| `LLM_MODEL_NAME` | 模型名称 | `deepseek-chat` | + +## 页面 + +| 页面 | 路由 | 说明 | +|------|------|------| +| Prompt 构建器 | `/` | 核心功能页 | +| 复盘看板 | `/dashboard` | 历史 Prompt 浏览 | +| 设置 | `/settings` | LLM 配置、主题切换 |