# writer-pro

**Repository Path**: jxcchen/writer-pro

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-16
- **Last Updated**: 2025-07-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 写作助手平台 (Writing Assistant Platform)

基于Flask+Vue+Claude API开发的学术论文写作助手平台。

## 功能特点

- 完整论文撰写：根据题目、目录和字数要求生成完整论文
- 论文部分撰写：针对论文特定章节进行撰写
- 自定义文档样式：提供多种格式模板，支持自定义样式设置
- 参考资料整合：支持上传和选择参考资料
- Claude API集成：利用强大的AI能力生成高质量学术内容

## 技术栈

### 后端
- Flask: Python Web框架
- Claude API: AI文本生成
- python-docx: Word文档处理

### 前端
- Vue.js: 前端框架
- Element UI: UI组件库

## 安装与运行

### 环境要求
- Python 3.8+
- Node.js 14+
- npm 6+

### 后端安装
1. 克隆仓库
```bash
git clone https://github.com/your-username/writer-pro.git
cd writer-pro
```

2. 安装依赖
```bash
pip install -r requirements.txt
```

3. 配置Claude API密钥
编辑`backend/config/config.py`文件，替换`CLAUDE_API_KEY`为你的密钥

4. 运行后端服务
```bash
cd backend
python app.py
```

### 前端安装
1. 安装依赖
```bash
cd frontend
npm install
```

2. 运行开发服务器
```bash
npm run serve
```

3. 构建生产版本
```bash
npm run build
```

## 系统架构

### 后端目录结构
- `/backend/api`: API路由和端点
- `/backend/config`: 配置文件
- `/backend/models`: 数据模型
- `/backend/utils`: 工具函数
- `/backend/static`: 静态文件和上传文件存储
- `/backend/templates`: 模板文件

### 前端目录结构
- `/frontend/src/components`: Vue组件
- `/frontend/src/views`: 页面视图
- `/frontend/src/router`: 路由配置
- `/frontend/src/store`: Vuex状态管理
- `/frontend/src/utils`: 工具函数
- `/frontend/src/assets`: 静态资源

## API文档

### 主要API端点

#### 健康检查
- GET `/api/health`: 检查API是否正常运行

#### 参考资料
- GET `/api/references`: 获取可用参考资料列表

#### 模板
- GET `/api/templates`: 获取可用文档模板
- POST `/api/save-template`: 保存新模板

#### 文件操作
- POST `/api/upload`: 上传参考资料文件
- GET `/api/download/<filename>`: 下载生成的文档

#### 论文生成
- POST `/api/generate-essay`: 生成完整论文
- POST `/api/generate-section`: 生成论文特定章节
- POST `/api/analyze-outline`: 分析论文大纲和字数分布

## 许可证

MIT License