# linkflow

**Repository Path**: zlztsb/linkflow

## Basic Information

- **Project Name**: linkflow
- **Description**: 一站式中间件管理工具
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-22
- **Last Updated**: 2026-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LinkFlow

LinkFlow — 跨平台数据库与消息队列管理工作台。

## 技术栈

- **后端**：Java 17, Spring Boot 3, PF4J（插件 SPI）
- **前端**：Vue 3, Element Plus, Vite
- **驱动**：MySQL, Redis, Kafka, MQTT

## 快速开始

### 1. 启动后端

```bash
cd linkflow-api
mvn spring-boot:run
```

后端默认 `http://127.0.0.1:8080`，Token 为 `dev`。

连接配置持久化在 `~/.linkflow/connections.json`（可通过环境变量 `LINKFLOW_DATA_DIR` 修改）。

### 2. 启动前端

```bash
cd linkflow-ui
yarn install
yarn dev
```

浏览器打开 `http://localhost:5173`，填写连接信息即可使用。

## 项目结构

```
linkflow/
├── linkflow-plugin-api/     # DB + MQ 插件 SPI
├── linkflow-core/           # 核心服务
├── linkflow-api/            # Spring Boot REST API
├── linkflow-plugins/        # 各驱动插件
├── linkflow-ui/             # Vue + Element Plus
├── linkflow-electron/       # Electron 桌面壳
└── docs/
    └── architecture.md
```

## 桌面应用

LinkFlow 通过 Electron 启动内嵌 Java 后端并加载前端界面。

> **注意**：安装包必须在目标平台上构建（Mac 包在 macOS 上打，Windows 包在 Windows 上打），因为内置 JRE 是平台相关的。

### macOS — 构建 .dmg

```bash
chmod +x scripts/*.sh
./scripts/package-mac.sh
```

产物：`linkflow-electron/release/LinkFlow-1.1.0-arm64.dmg`

### Windows — 构建安装包

```powershell
$env:JAVA_HOME = "C:\Program Files\Java\jdk-17"
.\scripts\package-windows.ps1
```

产物：
- `linkflow-electron/release/LinkFlow-Setup-1.1.0.exe`
- `linkflow-electron/release/LinkFlow-1.1.0-win.zip`

### 开发模式（三进程）

```bash
./scripts/dev.sh
```

或分别启动：

```bash
# 终端 1: Java
cd linkflow-api && LINKFLOW_TOKEN=dev mvn spring-boot:run

# 终端 2: Vue
cd linkflow-ui && yarn dev

# 终端 3: Electron
cd linkflow-electron && yarn install && LINKFLOW_SKIP_JAVA=1 yarn dev
```

## 文档

详见 [docs/architecture.md](docs/architecture.md)