docs:update

This commit is contained in:
2026-01-29 15:44:24 +08:00
parent 4dcb117601
commit 3d9c7a2b28
2 changed files with 78 additions and 22 deletions

28
.gitignore vendored Normal file
View File

@@ -0,0 +1,28 @@
//重要信息,依赖
node_modules/
.env
.env.local
.env.backup
.env.development.local
.env.test.local
.env.production.local
//其余忽略规则
logs/
.DS_Store
npm-debug.log*
yarn-debug.log*
yarn-error.log
lerna-debug.log*
dist/
build/
coverage/
logs/
*.log
.idea/
.vscode/
.cache/
sync_database.sqlite
//暂时忽略
app.js

View File

@@ -16,11 +16,11 @@ npm install
``` ```
该命令将安装以下依赖: 该命令将安装以下依赖:
- express (5.x): Web框架和HTTP服务器 - hono (4.x): 轻量级Web框架
- @hono/node-server (1.x): Hono Node.js服务器适配器
- axios (1.13.x): HTTP客户端库 - axios (1.13.x): HTTP客户端库
- better-sqlite3 (9.x): SQLite数据库驱动 - better-sqlite3 (12.x): SQLite数据库驱动
- dotenv (17.x): 环境变量加载 - dotenv (17.x): 环境变量加载
- express-rate-limit (8.x): 速率限制中间件
- j2m (1.1.x): Markdown与Jira格式转换库 - j2m (1.1.x): Markdown与Jira格式转换库
### 第二步:环境变量配置 ### 第二步:环境变量配置
@@ -344,24 +344,52 @@ DEBUG模式下:
- 内存锁防止重复处理同一工单 - 内存锁防止重复处理同一工单
## 代码结构 ## 代码结构
``` ```
src/ gitea-jira-sync/
config/ - 配置文件 ├── index.js - 主程序Hono应用入口
env.js - 环境变量加载 ├── mappings.json - 映射配置文件
mappings.js - 字段映射配置 ├── package.json - 项目依赖配置
db/ - 数据库相关 ├── README.md - 本文档
connection.js - 数据库连接 ├── how-to-use.md - 使用指南
issueMap.js - 映射表操作 ├── data/ - 数据目录
logic/ - 业务逻辑 ├── logs/ - 日志目录
converter.js - 数据转换 ├── public/ - 前端资源目录
syncManager.js - Gitea->Jira同步 ├── app.js - 配置编辑器应用脚本
jiraSyncManager.js - Jira->Gitea同步 ├── dashboard-app.js - 仪表板应用脚本
services/ - API服务 ├── dashboard.html - 仪表板页面
gitea.js - Gitea API客户端 ├── editor.html - 配置编辑器页面
jira.js - Jira API客户端 └── error.html - 错误页面
utils/ - 工具函数 └── src/
logger.js - 日志模块 ├── config/ - 配置模块
circuitBreaker.js - 熔断器 │ ├── env.js - 环境变量加载
index.js - 主程序 │ └── mappings.js - 字段映射配置管理
mappings.json -映射表 ├── db/ - 数据库模块
│ ├── connection.js - 数据库连接管理
│ └── issueMap.js - 工单映射表操作
├── logic/ - 业务逻辑模块
│ ├── converter.js - 字段数据转换
│ ├── syncManager.js - Gitea->Jira同步管理
│ └── jiraSyncManager.js - Jira->Gitea同步管理
├── routes/ - 路由模块
│ └── editor.js - 配置编辑器路由
├── services/ - 第三方API服务
│ ├── gitea.js - Gitea API客户端
│ └── jira.js - Jira API客户端
└── utils/ - 工具函数
├── logger.js - 日志模块
├── circuitBreaker.js - 熔断器实现
└── tests_created_by_claude/
├── cleanup-test-issues.js
└── comprehensive-test.js
``` ```
## 技术栈
- **Web框架**: Hono 4.x轻量级、高性能
- **服务器**: Node.js + @hono/node-server
- **数据库**: SQLite 3.xbetter-sqlite3驱动
- **HTTP客户端**: Axios
- **环境管理**: dotenv
- **格式转换**: j2mMarkdown↔Jira格式
- **前端**: Vanilla JS无框架依赖