快速开始

本文档将帮助你快速启动 HEI Boot 项目。

环境要求

软件	版本要求	说明
JDK	21+	项目使用 Java 21 编译和运行
Maven	3.6+	项目构建工具
MySQL	8.0+	主数据库
Redis	6.0+	缓存及会话存储

5 分钟快速启动

1. 克隆项目

git clone https://gitee.com/jiangbyte/hei-boot.git
cd hei-boot

2. 创建数据库

CREATE DATABASE IF NOT EXISTS hei_data DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;

执行 scripts/sqls/ 目录下的 SQL 脚本初始化数据库。

3. 修改配置

编辑 app/src/main/resources/application-local.yaml，修改数据库和 Redis 连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/hei_data?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowMultiQueries=true&allowPublicKeyRetrieval=true&zeroDateTimeBehavior=convertToNull&transformedBitIsBoolean=true&tinyInt1isBit=false
    username: root
    password: your_password
  data:
    redis:
      host: localhost
      port: 6379
      password: your_redis_password

4. 编译启动

mvn clean install
cd app
mvn spring-boot:run

或直接通过 IDE 运行 HeiApplication.java。

5. 访问系统

服务	地址	说明
后端服务	http://localhost:8081	默认端口
API 文档	http://localhost:8081/doc.html	Knife4j 接口文档
Druid 监控	http://localhost:8081/druid/	数据库监控面板

默认配置

• Token Header: token
• Token 有效期: 30 天
• 默认环境: local

下一步

• 安装指南 - 详细的安装和初始化步骤
• 配置说明 - 全面的配置文件说明
• 项目结构 - 深入了解模块组织
• 架构概览 - 架构设计理念