# xfsubmit

**Repository Path**: ouwin/xfsubmit

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-05
- **Last Updated**: 2026-07-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 宸轩中消 · 业务系统

本仓库包含业务后端 `xf-business-system` 与前端原型 `frontend-prototype` 的源码与运行说明。

## 目录结构

```
xiaofang-submit/
├── backend/                          # Maven 聚合工程
│   ├── pom.xml
│   ├── settings.xml                  # Maven 镜像与私服（可选）
│   └── xf-business-system/           # Spring Boot 业务服务
│       └── src/main/resources/
│           ├── application.yml
│           ├── application-dev.yml.example
│           └── db/                   # 数据库初始化脚本（见 script/）
├── frontend-prototype/               # Vue 3 + Vite 前端原型
└── script/                           # Docker 部署脚本（MySQL / Redis 等）
```

## 环境要求

| 工具 | 版本建议 |
|------|----------|
| JDK | 17+ |
| Maven | 3.8+ |
| Node.js | 18+（推荐 LTS） |
| MySQL | 5.7 / 8.0 |
| Redis | 6+ |

---

## 后端（xf-business-system）

### 1. Maven 配置（settings.xml）

`backend/settings.xml` 用于：

- 配置阿里云公共镜像，加速依赖下载
- 配置私有仓库，解析 `com.chenxuan` 相关内部依赖

**用法（任选其一）：**

```powershell
# 单次构建指定 settings
cd backend
mvn clean package -DskipTests -s settings.xml
```

或将 `settings.xml` 中 `<servers>`、`<mirrors>`、`<profiles>` 合并到本机 `~/.m2/settings.xml`（推荐，避免把账号提交到 Git）。

> 私服 `<server>` 的账号密码请使用本机配置，勿将真实密码写入仓库。

### 2. 开发配置

```powershell
cd backend\xf-business-system\src\main\resources
copy application-dev.yml.example application-dev.yml
```

按本地环境修改 `application-dev.yml` 中的 MySQL、Redis 等连接信息。示例默认：

- 服务端口：`8180`（与前端 `request.js` 中 `baseURL` 一致）
- 数据库：`xf_business_system`

首次建库可执行 `db/` 下脚本，或使用 `script/02-start-mysql-clean.sh` 初始化 Docker MySQL。

### 3. 编译打包

在 `backend` 目录执行：

```powershell
cd backend

# 编译
mvn clean compile -pl xf-business-system -s settings.xml

# 打包（生成可运行 jar）
mvn clean package -pl xf-business-system -DskipTests -s settings.xml
```

产物路径：

`backend/xf-business-system/target/xf-business-system-1.0.0.jar`

### 4. 本地运行

**方式 A：Maven 启动（开发推荐）**

```powershell
cd backend
mvn spring-boot:run -pl xf-business-system -s settings.xml -Dspring-boot.run.profiles=dev
```

**方式 B：运行 jar**

```powershell
cd backend\xf-business-system\target
java -jar xf-business-system-1.0.0.jar --spring.profiles.active=dev
```

默认 `application.yml` 中 `spring.profiles.active=prod`，本地开发请显式指定 `dev`。

### 5. 验证

| 项 | 地址 / 说明 |
|----|-------------|
| 服务端口 | `http://localhost:8180`（dev 配置） |
| API 文档 | 视项目 Knife4j 配置而定（若已启用） |
| 测试账号 | 见 `backend/DEVELOPMENT.md` |

---

## 前端（frontend-prototype）

### 1. 安装依赖

```powershell
cd frontend-prototype
npm install
```

国内网络可选用：`npm install --registry=https://registry.npmmirror.com`

### 2. 开发运行

```powershell
npm run dev
```

- 默认地址：`http://localhost:3000`
- 后端接口：在 `src/utils/request.js` 中配置，默认 `http://localhost:8180`
- 需先启动后端（`dev` 配置、端口 8180）

### 3. 生产构建

```powershell
npm run build
```

静态资源输出到 `frontend-prototype/dist/`，可交由 Nginx 等托管。

### 4. 本地预览构建结果

```powershell
npm run preview
# 或
npm run preview:local
```

---

## 联调流程（本地）

1. 启动 MySQL、Redis（本机或 `script/` 下 Docker 脚本）。
2. 配置并启动后端：`mvn spring-boot:run ... -Dspring-boot.run.profiles=dev`。
3. 启动前端：`cd frontend-prototype && npm run dev`。
4. 浏览器访问 `http://localhost:3000` 登录使用。

---

## Docker 部署（可选）

业务 jar 构建完成后，可在 `backend` 目录使用 Dockerfile 打镜像；MySQL / Redis / 微服务编排见 `script/` 目录脚本。

```powershell
# 示例：先打包再构建镜像
cd backend
mvn clean package -pl xf-business-system -DskipTests -s settings.xml
docker build -f Dockerfile -t xf-business-system:latest .
```

---

## 更多说明

- 后端开发细节：`backend/DEVELOPMENT.md`
- IDE 编码与控制台中文：`backend/IDE编码配置说明.md`