# SlideAgent

**Repository Path**: uai-team/SlideAgent

## Basic Information

- **Project Name**: SlideAgent
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-11
- **Last Updated**: 2026-02-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SlideAgent — 让 PPT 生成更简单

[![English](https://img.shields.io/badge/README-English-blue.svg)](README.md) | [中文](README_zh.md)

**SlideAgent** 是一款开源的 AI 驱动演示文稿生成工具。输入主题或上传文档即可生成大纲、内容与设计，并支持在线预览与多种格式导出。

##### 创作不易，欢迎点个 Star ✨

![PPTAgent 主页](images/home.png)



## ✨ 亮点

- **AI 生成 PPT** — 自动生成大纲、内容与设计
- **知识库** — 上传文档并基于知识库生成 PPT
- **在线预览与编辑** — 浏览器内预览并直接编辑文本
- **在线分享** — 生成分享链接，支持设置有效期
- **任务队列** — 批量任务后台排队处理
- **PPTX 导出服务** — 独立的 export_tool 服务将 HTML 幻灯片转换为可编辑 PPTX

## ✅ 已完成

- [x] **内容编辑** — 预览页面直接编辑文本
- [x] **在线预览** — 浏览器内实时预览
- [x] **导出** — 支持 PDF / HTML / PPTX（PPTX 样式可能丢失，持续优化中）
- [x] **状态管理** — Agent 任务状态全局持久化

## 🧭 规划中

- [ ] **对话式编辑** — 通过对话持续修改与优化内容
- [ ] **数据库搜索工具** — 直接调用知识库工具
- [ ] **多版本管理** — 版本保存、对比与回滚

## 🚀 快速开始

### 前置条件

- Docker 和 Docker Compose
- Git

### 使用 Docker Compose 运行

1. **克隆仓库**
   ```bash
   git clone https://github.com/Mrguanglei/SlideAgent.git
   cd SlideAgent
   ```

2. **配置 (可选)**
   复制 `.env.example` 为 `.env` 并按需修改：
   ```bash
   cp .env.example .env
   ```
   可在 `.env` 中配置数据库与 LLM API 等参数。

3. **构建并启动服务**
   ```bash
   docker-compose up --build -d
   ```

4. **访问应用**
   - **前端:** [http://localhost:3000](http://localhost:3000)
   - **后端 API:** [http://localhost:8000/docs](http://localhost:8000/docs)

## 🧩 PPTX 导出服务（HTML -> PPTX）

- **服务**：`export_tool`（FastAPI）独立运行，由 Docker Compose 启动
- **链路**：后端 `/api/ppt/export` -> export_tool `/api/export_tool/pptx`
- **技术**：Playwright（Chromium）渲染 HTML，dom-to-pptx 转换为 PPTX，并支持字体嵌入与图标资产
- **更多**：详见 `export_tool/README.md` 的 API 与部署说明

## ⚙️ 环境变量

在项目根目录创建 `.env` 文件以覆盖默认配置。

| 变量 | 默认值 | 说明 |
| :--- | :--- | :--- |
| `POSTGRES_DB` | `pptagent` | 数据库名称 |
| `POSTGRES_USER` | `pptagent` | 数据库用户名 |
| `POSTGRES_PASSWORD` | `pptagent` | 数据库密码 |
| `DATABASE_URL` | `postgresql+asyncpg://...` | 数据库连接字符串 |
| `PPTAGENT_API_BASE_URL` | `https://open.bigmodel.cn/api/paas/v4/` | PPT 生成 LLM API 地址 |
| `PPTAGENT_API_KEY` | `your_api_key` | PPT 生成 LLM API Key |
| `PPTAGENT_MODEL` | `glm-4-flash` | PPT 生成 LLM 模型 |
| `KNOWLEDGE_LLM_BASE_URL` | `PPTAGENT_API_BASE_URL` | 知识库 LLM API 地址 |
| `KNOWLEDGE_LLM_API_KEY` | `PPTAGENT_API_KEY` | 知识库 LLM API Key |
| `KNOWLEDGE_LLM_MODEL` | `glm-4-flash` | 知识库 LLM 模型 |
| `KNOWLEDGE_EMBEDDING_MODEL` | `embedding-3` | 知识库向量化模型 |
| `KNOWLEDGE_UPLOAD_DIR` | `/tmp/knowledge_uploads` | 知识库文件上传目录 |

## 📸 界面截图

| 主页 | 对话生成 |
| :--- | :--- |
| ![主页](images/home.png) | ![对话生成](images/chat.png) |
| **知识库** | **全局搜索** |
| ![知识库](images/knowledge.png) | ![全局搜索](images/search.png) |
| **在线编辑** | **多种下载** |
| ![在线编辑](images/editor.png) | ![多种下载](images/download.png) |

## 🛠️ 项目结构

```
.env.example         # 环境变量示例
docker-compose.yml   # Docker 编排配置
README.md            # 项目说明

backend/             # Python 后端 (FastAPI)
├── services/        # 核心服务（导出、分享、知识库）
├── routers/         # API 路由
├── database/        # 数据库模型与 CRUD
├── api_server.py    # FastAPI 服务器入口
├── requirements.txt # Python 依赖
└── Dockerfile

frontend/            # React 前端 (Vite)
├── src/
│   ├── pages/       # 页面组件 (Home, Knowledge, ShareView)
│   ├── components/  # 可复用组件 (Sidebar, Modals, etc.)
│   ├── lib/         # API 请求与工具函数
│   └── types/       # TypeScript 类型定义
├── package.json     # Node.js 依赖
├── vite.config.ts   # Vite 配置
└── Dockerfile

export_tool/         # 导出服务 (PDF/PNG/HTML/PPTX)
├── app/             # FastAPI 应用与服务
├── dom-to-pptx/     # HTML -> PPTX 核心库
├── fonts/           # 字体资源（嵌入）
└── Dockerfile
```

## 🤝 贡献

欢迎各种形式的贡献！如果您有任何想法或建议，欢迎提交 Pull Request 或 Issue。

[![Star History Chart](https://api.star-history.com/svg?repos=Mrguanglei/SlideAgent&type=Date)](https://star-history.com/#Mrguanglei/SlideAgent&Date)

## 🙏 致谢

- [PPTAgent (CAS)](https://github.com/icip-cas/PPTAgent) - 本项目基于此开源项目二次开发，感谢原作者贡献。
- [shadcn/ui](https://ui.shadcn.com/) - 前端 UI 组件库。
- [FastAPI](https://fastapi.tiangolo.com/) - 高性能的 Python Web 框架。
- [React](https://react.dev/) - 用于构建用户界面的 JavaScript 库。
- [dom-to-pptx](https://github.com/atharva9167j/dom-to-pptx/tree/master/src) - 用于导出的 pptx 静态库

## 📄 许可证

本项目遵循 **[AGPL-3.0 协议](https://www.gnu.org/licenses/agpl-3.0.html)**。仅供学习和交流使用，禁止用于任何商业用途。