# redmine-console

**Repository Path**: ksdhy/redmine-console

## Basic Information

- **Project Name**: redmine-console
- **Description**: 对接开源项目管理工具redmine，通过对应的token对接，实现功能增强
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-12
- **Last Updated**: 2026-08-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Redmine Console

Redmine Console 是一个基于 Electron 的桌面应用程序，用于在本地管理 Redmine 项目问题，并与 SVN/Git 版本控制系统进行集成。它提供了直观的 GUI 界面，方便开发者在日常工作中快速处理问题、创建分支、提交代码等操作。

## 功能特性

* **Redmine 集成**: 直接在应用中查看、搜索、创建和编辑 Redmine 问题。
* **分支管理**: 支持从问题创建 Git/SVN 分支，并进行分支操作（如合并）。
* **编辑器集成**: 可配置启动外部编辑器（如 VS Code）进行代码编辑。
* **系统托盘**: 支持最小化到系统托盘，保持后台运行。
* **自动更新**: 支持应用自动更新功能。
* **跨平台**: 基于 Electron 支持 Windows、macOS、Linux 平台。

## 技术栈

* **前端**: Vue.js 3 + TypeScript + Vite
* **后端**: Node.js + TypeScript (Electron 主进程)
* **构建工具**: Electron Builder
* **样式**: CSS (自定义样式文件)

## 快速开始

### 环境要求

* Node.js (推荐 LTS 版本)
* npm 或 yarn

### 安装依赖

```bash
npm install
```

### 开发模式运行

```bash
npm run dev
```

该命令会启动开发服务器并打开应用窗口。在开发模式下，应用会启用热重载。

### 构建发布版本

```bash
npm run build
```

构建完成后，安装包会生成在 `dist` 目录下。

## 主要模块说明

### 客户端 (`src/client`)

包含 Vue.js 前端代码，负责 UI 渲染和用户交互。

* `App.vue`: 主应用组件。
* `api.ts`: 定义与主进程通信的接口。
* `types.ts`: 前端使用的 TypeScript 类型定义。
* 各种 Modal 组件 (`CreateIssueModal`, `AssignIssueModal`, `BranchOperationModal` 等): 用于处理特定任务的弹窗。
* `styles.css`: 全局样式文件。

### 主进程 (`src/electron`)

负责 Electron 主进程逻辑，处理系统级操作。

* `main.ts`: 应用入口，负责窗口管理、托盘创建等。
* `ipc-handlers.ts`: 处理渲染进程发来的 IPC 请求。
* `redmine-config-store.ts`: 管理 Redmine 配置的存储。
* `create-window.ts`: 创建和管理应用窗口。
* `create-tray.ts`: 创建系统托盘图标。
* `app-updater.ts`: 处理应用自动更新。

### 服务端 (`src/server`)

提供后端服务逻辑，处理 Redmine API 调用、SVN/Git 命令执行等。

* `redmine-client.ts`: Redmine API 客户端封装。
* `svn-branch-service.ts`: SVN 分支操作服务。
* `project-automation-service.ts`: 项目自动化相关服务。
* `editor-integration.ts`: 外部编辑器集成逻辑。
* `app-settings-store.ts`: 应用设置存储。

## 配置说明

应用支持通过配置文件或界面设置 Redmine 服务器地址、API 密钥等。具体配置项请参考界面中的设置选项。

##  Contributing

欢迎贡献代码！请遵循以下步骤：

1. Fork 本仓库。
2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)。
3. 提交你的改动 (`git commit -m 'Add some AmazingFeature'`)。
4. 推送到分支 (`git push origin feature/AmazingFeature`)。
5. 创建一个 Pull Request。

## License

本项目采用 [MIT License](LICENSE) 开源协议。