liumangmang
91 lines
1.7 KiB
Markdown
91 lines
1.7 KiB
Markdown
# 快速开始指南
|
||
|
||
3 步快速上手「SVN/Git 日报周报月报一键生成」
|
||
|
||
---
|
||
|
||
## 方式一：Docker（推荐）
|
||
|
||
### 第 1 步：启动服务
|
||
|
||
```bash
|
||
cd release/docker
|
||
docker compose up -d
|
||
```
|
||
|
||
### 第 2 步：打开浏览器
|
||
|
||
访问：http://localhost:18088
|
||
|
||
### 第 3 步：生成报表
|
||
|
||
1. 点击左侧「报表生成」
|
||
2. 选择仓库类型（SVN 或 Git）
|
||
3. 填写仓库信息
|
||
4. 选择报表周期（日报/周报/月报）
|
||
5. 点击「生成 Markdown + Excel」
|
||
|
||
完成！报表在 `outputs/` 目录下。
|
||
|
||
---
|
||
|
||
## 方式二：Windows
|
||
|
||
### 第 1 步：安装 Java
|
||
|
||
如果尚未安装，访问 https://adoptium.net/ 下载 JRE 8 (LTS)。
|
||
|
||
### 第 2 步：启动服务
|
||
|
||
双击 `start.bat`
|
||
|
||
### 第 3 步：生成报表
|
||
|
||
浏览器打开 http://localhost:18088，按照界面提示操作。
|
||
|
||
---
|
||
|
||
## 方式三：macOS / Linux
|
||
|
||
### 第 1 步：启动服务
|
||
|
||
```bash
|
||
cd release/unix
|
||
./start.sh
|
||
```
|
||
|
||
### 第 2 步：生成报表
|
||
|
||
浏览器打开 http://localhost:18088，按照界面提示操作。
|
||
|
||
---
|
||
|
||
## 示例：生成本周周报
|
||
|
||
1. 打开 http://localhost:18088
|
||
2. 左侧点击「报表生成」
|
||
3. 选择「Git」仓库类型
|
||
4. 填写 Git 仓库路径：`/home/user/my-project`
|
||
5. 报表周期选择「周报」
|
||
6. 基准日期选择本周任意一天（默认今天）
|
||
7. 点击「生成 Markdown + Excel」
|
||
8. 等待完成，自动下载 Excel
|
||
|
||
---
|
||
|
||
## 可选：配置 AI 分析
|
||
|
||
如需 AI 自动生成工作摘要：
|
||
|
||
1. 访问 https://platform.deepseek.com 获取 API Key
|
||
2. 在 Web 工作台 → 系统设置 → 填入 API Key
|
||
3. 生成报表时勾选「启用 AI 摘要」
|
||
|
||
不配置也可正常使用基础功能。
|
||
|
||
---
|
||
|
||
## 需要帮助？
|
||
|
||
查看完整文档：`docs/用户手册.md`
|