# FlowCI

**Repository Path**: untitled045/flow-ci

## Basic Information

- **Project Name**: FlowCI
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-03
- **Last Updated**: 2026-06-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FlowCI

一个轻量级的 CI/CD 平台，支持自定义流水线、多步骤执行和实时日志输出。

## 项目作用

- **项目管理**：管理 Git 仓库信息，支持配置认证信息
- **构建节点管理**：管理 SSH 连接的构建服务器
- **流水线模板**：自定义多步骤流水线，支持 Git 拉取、Maven 构建、Docker 构建、Shell 执行、K8s 部署等步骤
- **任务执行**：支持并发任务控制和任务队列，实时查看执行日志
- **关键输出**：从执行日志中提取关键信息（如 commit id、镜像标签等）

## 项目目录结构

```
custom_cicd/
├── backend/                 # 后端服务
│   ├── app/
│   │   ├── api/            # API 路由
│   │   ├── core/           # 核心配置
│   │   ├── engine/         # 执行引擎
│   │   │   └── steps/      # 步骤执行器
│   │   ├── models/         # 数据模型
│   │   ├── schemas/        # Pydantic 模式
│   │   └── services/       # 业务逻辑
│   ├── main.py             # 后端启动文件
│   ├── requirements.txt    # Python 依赖
│   └── .env.example        # 环境变量示例
├── frontend/               # 前端应用
│   ├── src/
│   │   ├── api/            # API 封装
│   │   ├── components/     # 组件
│   │   ├── router/         # 路由
│   │   ├── store/          # Pinia 状态管理
│   │   └── views/          # 页面
│   └── package.json        # Node 依赖
└── docs/                   # 文档
```

## 项目启动命令

### 🐳 Docker 镜像构建

Docker 镜像构建、PyInstaller 打包、生产部署说明请查看：

[README-BUILD.md](./README-BUILD.md)

### 🚀 一键启动（推荐）

```bash
# 一键启动前后端服务
./scripts/start.sh
```

### 🛑 一键停止

```bash
# 一键停止所有服务，自动清理端口占用
./scripts/stop.sh
```

### 📋 查看状态

```bash
# 查看服务运行状态
./scripts/status.sh
```

## 环境要求

本地开发需要以下环境：

- **Python**: 3.11.13
- **Node.js**: 22
- **包管理器**: pnpm
- **Git**: 任意较新版本

---

### 手动启动（可选）

#### 后端启动

```bash
# 进入后端目录
cd backend

# 安装依赖
pip install -r requirements.txt

# 复制环境变量示例并配置
cp .env.example .env
# 编辑 .env 文件配置数据库等信息（可选，默认配置已可用）

# 启动后端服务（开发模式，带热重载）
# 方式 1：使用 Python 模块方式运行（推荐）
python -m app.main

# 方式 2：使用 uvicorn 命令
uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload
```

后端服务默认运行在 `http://localhost:8000`

后端 API 文档地址：`http://localhost:8000/docs`

#### 前端启动

```bash
# 进入前端目录
cd frontend

# 安装依赖
npm install

# 启动前端开发服务器
npm run dev
```

前端服务默认运行在 `http://localhost:3000`

## 技术栈

- **后端**：FastAPI + SQLAlchemy + Uvicorn
- **前端**：Vue 3 + TypeScript + Element Plus + Pinia + Vite
- **数据库**：SQLite（默认）
- **执行引擎**：SSH + 异步任务队列