# project-deployment-platform

**Repository Path**: zheng_yongtao/project-deployment-platform

## Basic Information

- **Project Name**: project-deployment-platform
- **Description**: 项目部署平台 - 一键部署Gitee项目到服务器
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-19
- **Last Updated**: 2025-08-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 开发中

## README

# 项目部署平台

一个基于 Vue3 + TypeScript + Vite 的项目部署平台，支持一键将 Gitee 项目拉取并打包部署到服务器指定目录中。

## 功能特性

- 🚀 一键部署：支持从 Gitee 仓库拉取代码并自动部署
- 🔧 灵活配置：支持自定义构建命令、部署前后脚本
- 📊 实时监控：部署状态实时更新，支持查看部署日志
- 🔐 安全连接：支持密码和私钥两种 SSH 认证方式
- 📱 现代化界面：基于 Element Plus 的美观界面

## 技术栈

### 前端
- Vue 3
- TypeScript
- Vite
- Element Plus
- Pinia
- Vue Router

### 后端
- Node.js
- Express
- Node SSH
- Simple Git
- Archiver

## 快速开始

### 1. 安装依赖

```bash
npm install
```

### 2. 启动开发服务器

```bash
# 同时启动前端和后端
npm run dev:full

# 或者分别启动
npm run dev        # 启动前端 (端口 3000)
npm run server     # 启动后端 (端口 3001)
```

### 3. 配置服务器

1. 打开应用，点击右上角的"配置"按钮
2. 填写服务器信息：
   - 服务器地址
   - SSH 端口（默认 22）
   - 用户名
   - 认证方式（密码或私钥）
3. 点击"测试连接"验证配置
4. 保存配置

### 4. 创建部署

1. 点击"新建部署"按钮
2. 填写项目信息：
   - 项目名称
   - Gitee 仓库地址（格式：https://gitee.com/username/repository.git）
   - 分支名称
   - 部署路径
   - 构建命令（如：npm run build）
   - 部署前后命令（可选）
3. 点击"创建部署"

### 5. 执行部署

1. 在部署列表中找到要部署的项目
2. 点击"重新部署"按钮
3. 等待部署完成，查看实时日志

## 部署流程

1. **连接服务器**：通过 SSH 连接到目标服务器
2. **克隆代码**：从 Gitee 仓库拉取指定分支的代码
3. **执行前置命令**：运行部署前的准备工作（如安装依赖）
4. **构建项目**：执行构建命令生成部署文件
5. **打包上传**：将构建产物打包并上传到服务器
6. **解压部署**：在服务器上解压文件到指定目录
7. **执行后置命令**：运行部署后的操作（如重启服务）

## 项目结构

```
project-deployment-platform/
├── src/                    # 前端源码
│   ├── components/         # Vue 组件
│   ├── stores/            # Pinia 状态管理
│   ├── views/             # 页面组件
│   ├── router/            # 路由配置
│   ├── App.vue            # 根组件
│   └── main.ts            # 入口文件
├── server/                # 后端源码
│   └── index.js           # Express 服务器
├── public/                # 静态资源
├── package.json           # 项目配置
├── vite.config.ts         # Vite 配置
├── tsconfig.json          # TypeScript 配置
└── README.md              # 项目说明
```

## 配置说明

### 服务器配置

- **服务器地址**：目标服务器的 IP 地址或域名
- **SSH 端口**：SSH 服务端口，通常为 22
- **用户名**：SSH 登录用户名
- **认证方式**：
  - 密码：直接使用密码登录
  - 私钥：使用 SSH 私钥文件登录

### 部署配置

- **项目名称**：用于标识部署项目的名称
- **Gitee 仓库地址**：完整的 Git 仓库地址
- **分支**：要部署的代码分支
- **部署路径**：服务器上的部署目录
- **构建命令**：生成部署文件的命令
- **部署前命令**：部署前执行的命令（可选）
- **部署后命令**：部署后执行的命令（可选）

## 注意事项

1. 确保服务器已安装 Git、Node.js 等必要工具
2. 确保服务器用户有足够的权限访问部署目录
3. 私钥文件路径需要是绝对路径
4. 构建命令需要在项目根目录下执行
5. 部署路径需要有写入权限

## 开发

### 构建生产版本

```bash
npm run build
```

### 预览生产版本

```bash
npm run preview
```

## 许可证

MIT License