refactor: remove frontend and keep backend-only build
This commit is contained in:
@@ -1,37 +1,78 @@
|
||||
# svn-log-tool
|
||||
# SVN/Git 日报周报月报一键生成
|
||||
|
||||
SVN 日志抓取与 AI 工作量分析工具,统一使用 Web 工作台入口。
|
||||
本地离线运行的代码仓库报表生成工具,支持 SVN 和 Git 仓库,一键生成日报、周报、月报。当前仓库仅保留 `Spring Boot` 后端与打包链路。
|
||||
|
||||
## 入口
|
||||
## 核心能力
|
||||
|
||||
- `com.svnlog.web.WebApplication`
|
||||
- SVN(远程)+ Git(本地路径)双仓库支持
|
||||
- 日报 / 周报 / 月报自动换算日期区间
|
||||
- Markdown + Excel 双产物导出
|
||||
- DeepSeek AI 摘要增强,可选开启
|
||||
- 异步任务管理、历史查询、文件下载
|
||||
- 单 jar、Docker、源码三种交付方式
|
||||
|
||||
## 常用命令
|
||||
## 项目结构
|
||||
|
||||
```text
|
||||
backend/ Spring Boot API 与打包入口
|
||||
docs/ 用户文档、销售文案、打包说明
|
||||
release/ 发行包模板目录
|
||||
```
|
||||
|
||||
## 开发命令
|
||||
|
||||
### 后端开发
|
||||
|
||||
```bash
|
||||
# 一键启动(Docker)
|
||||
make up
|
||||
|
||||
# 查看状态
|
||||
make status
|
||||
|
||||
# 一键关闭
|
||||
make down
|
||||
|
||||
# 编译
|
||||
cd backend
|
||||
mvn clean compile
|
||||
|
||||
# 打包
|
||||
mvn clean package -DskipTests
|
||||
|
||||
# 启动 Web(非 Docker 备用方式)
|
||||
mvn spring-boot:run -Dspring-boot.run.mainClass=com.svnlog.web.WebApplication
|
||||
```
|
||||
|
||||
## 代码结构
|
||||
### 整体构建
|
||||
|
||||
- `com.svnlog.web`:Web 入口、控制器、DTO、服务
|
||||
- `com.svnlog.core.svn`:SVN 连接、日志抓取模型
|
||||
- `com.svnlog.core.report`:Markdown 报告输出能力
|
||||
```bash
|
||||
make build
|
||||
```
|
||||
|
||||
更多运行和功能说明见 `docs/`。
|
||||
或:
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
mvn clean package -DskipTests
|
||||
```
|
||||
|
||||
说明:仓库已移除前端代码,`backend/pom.xml` 现在只负责后端构建与打包。
|
||||
仓库内置 `backend/.mvn/settings.xml`,默认使用国内镜像源完成 `maven` 依赖下载。
|
||||
|
||||
## 运行方式
|
||||
|
||||
### Docker 方式
|
||||
|
||||
```bash
|
||||
make up
|
||||
```
|
||||
|
||||
访问:`http://localhost:18088`
|
||||
|
||||
### 本机运行
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
mvn spring-boot:run -Dspring-boot.run.mainClass=com.svnlog.web.WebApplication
|
||||
```
|
||||
|
||||
## 文档
|
||||
|
||||
- [发行版打包指南](docs/发行版打包指南.md)
|
||||
- [用户手册](docs/用户手册.md)
|
||||
- [快速开始](docs/快速开始.md)
|
||||
- [销售文案](docs/销售文案.md)
|
||||
|
||||
## 技术栈
|
||||
|
||||
- 后端:Java 8、Spring Boot 2.7.18
|
||||
- SVN:SVNKit
|
||||
- Git:JGit
|
||||
- Excel:Apache POI
|
||||
- AI:DeepSeek API、OkHttp、Gson
|
||||
|
||||
Reference in New Issue
Block a user