# jenkins-ci-demo

**Repository Path**: jun-wan/jenkins-ci-demo

## Basic Information

- **Project Name**: jenkins-ci-demo
- **Description**: jenkins-ci-demo  后端Maven 项目
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Jenkins CI Demo Backend

[![Java](https://img.shields.io/badge/Java-8+-orange.svg)](https://www.oracle.com/java/)
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-2.7.18-brightgreen.svg)](https://spring.io/projects/spring-boot)
[![Maven](https://img.shields.io/badge/Maven-3.6+-blue.svg)](https://maven.apache.org/)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

一个基于 Spring Boot 的 Jenkins CI/CD 演示项目后端服务，提供系统信息 API 接口。

## 📋 项目简介

这是一个用于演示 Jenkins CI/CD 流程的后端项目，采用 Spring Boot 框架构建，提供 RESTful API 接口供前端调用。项目结构简洁，适合用于学习和演示持续集成/持续部署的最佳实践。

## 🚀 技术栈

- **Java 8+** - 编程语言
- **Spring Boot 2.7.18** - 应用框架
- **Spring Web** - Web 服务支持
- **Lombok** - 减少样板代码
- **Maven** - 项目构建工具

## 📁 项目结构

```
jenkins-ci-demo/
├── src/
│   └── main/
│       ├── java/
│       │   └── com/cpolar/jenkinscidemo/
│       │       ├── JenkinsCiDemoApplication.java    # 主应用类
│       │       ├── controller/
│       │       │   └── InfoController.java         # 系统信息控制器
│       │       └── model/
│       │           └── SystemInfo.java             # 系统信息模型
│       └── resources/
│           └── application.yml                     # 应用配置文件
├── pom.xml                                        # Maven 配置文件
└── README.md                                      # 项目说明文档
```

## 🔧 快速开始

### 环境要求

- Java 8 或更高版本
- Maven 3.6 或更高版本

### 安装与运行

1. **克隆项目**
   ```bash
   git clone https://github.com/TanChengBin/jenkins-ci-demo.git
   cd jenkins-ci-demo
   ```

2. **编译项目**
   ```bash
   mvn clean compile
   ```

3. **运行应用**
   ```bash
   mvn spring-boot:run
   ```
   
   或者先打包再运行：
   ```bash
   mvn clean package
   java -jar target/jenkins-ci-demo-1.0.jar
   ```

4. **验证服务**
   
   应用启动后，访问：http://localhost:8080/api/info
   
   应该返回如下 JSON 响应：
   ```json
   {
     "name": "jenkins-ci-demo",
     "version": "1.0",
     "author": "cpolar"
   }
   ```

## 📚 API 文档

### 获取系统信息

**接口地址：** `GET /api/info`

**描述：** 获取系统基本信息

**请求参数：** 无

**响应示例：**
```json
{
  "name": "jenkins-ci-demo",
  "version": "1.0", 
  "author": "cpolar"
}
```

**响应字段说明：**
| 字段 | 类型 | 描述 |
|------|------|------|
| name | String | 项目名称 |
| version | String | 项目版本号 |
| author | String | 项目作者 |

## 🔨 构建与部署

### Maven 构建

```bash
# 清理并编译
mvn clean compile

# 运行测试
mvn test

# 打包应用
mvn clean package

# 跳过测试打包
mvn clean package -DskipTests
```



## 🧪 测试

### 运行单元测试
```bash
mvn test
```

### API 测试
使用 curl 测试 API：
```bash
curl -X GET http://localhost:8080/api/info
```

使用 Postman 或其他 API 测试工具测试接口。

## 📝 配置说明

### application.yml 配置

```yaml
# 应用配置
spring:
  application:
    name: jenkins-ci-demo

# 服务器配置  
server:
  port: 8080

# 日志配置
logging:
  level:
    com.cpolar.jenkinscidemo: INFO
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss} - %msg%n"
```

### 端口配置
- 默认端口：8080
- 可通过 `server.port` 配置项修改

## 🤝 贡献指南

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

## 📄 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。

## 👥 作者

- **cpolar** - *初始工作* - [TanChengBin](https://github.com/TanChengBin)

## 🔗 相关项目

- [Jenkins CI Demo Frontend](https://github.com/TanChengBin/jenkins-ci-demo-frontend) - 配套的前端项目

## 📞 联系方式

如有问题或建议，请通过以下方式联系：

- 提交 [Issue](https://github.com/TanChengBin/jenkins-ci-demo/issues)
- 发起 [Pull Request](https://github.com/TanChengBin/jenkins-ci-demo/pulls)

---

⭐ 如果这个项目对你有帮助，请给它一个星标！