# boot-react

**Repository Path**: KissedBySnow/boot-react

## Basic Information

- **Project Name**: boot-react
- **Description**: boot-react
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2024-05-13
- **Last Updated**: 2025-09-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: React

## README

# Boot React

[toc]

## 一、项目部署

### Quick Start

执行如下命令：

````shell script
./gradlew clean build -x test && ./backend/build/libs/boot-react.jar
````

浏览器访问 `http://${ip}:8080`，用户名 `admin`，密码 `admin`。

### 编译方法

> 所有的命令行在 *nix 系统下执行，如果在 windows 下执行请修改路径分隔符等差异的部分。

编译项目，生成 boot jar，忽略单元测试。

````shell script
./gradlew clean build -x test -info
````

> - `clean`: 清理项目，删除构建产物，以便重新构建。
> - `build`: 构建项目，生成可执行文件或库文件。
> - `-x test`: 排除运行测试的步骤。在构建过程中，通常会运行测试来验证代码的正确性，但使用 `-x test` 参数可以跳过这个步骤。
> - `-info`: 设置日志级别为详细信息。使用此参数可以获得更多的构建过程日志，包括每个任务的详细输出。

生成的 Jar 在 `backend/build/libs` 下

## 二、项目开发

### 开发模式下前后端分离执行的方法

项目分为 backend 和 frontend 两个目录。

#### Backend

- backend 目录下执行：

  ````shell script
  ../gradlew bootRun -x test -info
  ````

- 持续编译：

  ````sh
  ../gradlew build --continuous -x :frontend:bundle -x test
  ````

  > - `build`: 构建项目，生成可执行文件或库文件。
  > - `--continuous`: 启用连续构建模式。在此模式下，Gradle 会监视文件系统中的更改，并自动重新构建项目。
  > - `-x :frontend:bundle`: 排除名为 `frontend:bundle` 的任务。这意味着在构建过程中不会执行名为 `bundle` 的任务，该任务似乎是位于 `frontend` 子项目中的任务。
  > - `-x test`: 排除运行测试的步骤。在构建过程中，通常会运行测试来验证代码的正确性，但使用 `-x test` 参数可以跳过这个步骤。

#### Frontend

1. frontend 目录下执行：

   ```sh
   npm install
   npm start -verbose
   ```

### 前端关闭 MOCK

可以通过配置关闭：

```javascript
export default {
  mock: { exclude: ['**/*.js'] },
};
```

也可以通过环境变量临时关闭，`MOCK=none npm start`;



## 三、其他

### 代码规范

提交代码前请按要求调整代码格式。

- 后端遵从 Java 规范。提交前，需要使用检查代码。

  ````shell script
  ./gradlew check
  ````

- 前端通过 eslint 保证代码规范：

  ````shell script
  npm run lint
  ````

### Systemd 部署

配置文件：`/etc/systemd/system/boot-react.service`

```text
[Unit]
Description=Boot React
After=syslog.target

[Service]
User=root
Environment='JAVA_HOME=/usr/java/default' 'JAVA_OPTS=-Xmx4g -Xms4g'
ExecStart=/opt/boot-react/boot-react.jar
SuccessExitStatus=143

[Install]
WantedBy=multi-user.target
```

### Windows 环境下换行符的问题

> Windows 环境下默认的换行符是 CRLF，所以安装 git 的时候，会有一个可选择的配置 line ending conversions。
>
> 默认选项是将 LF 作为换行符的文件转换为 CRLF，即设置 `core.autocrlf=true`。如果选择 "Checkout as-is, commit as-is"，那么自动转换将会关闭。
>

我们推荐关闭转换。如果已经安装了 git，可以使用以下**任意一条**命令修改配置。

```sh
git config --system core.autocrlf false
git config --global core.autocrlf false
```