Start-Admin-BootStart-Admin-Boot
文档导航

快速开始

环境准备

  • JDK:25+
  • Maven:3.8+
  • Node.js:20+(推荐 22+)、pnpm:9+
  • PostgreSQL:14+、Redis:6.0+

获取代码

git clone <仓库地址>
cd start-admin-boot

初始化基础设施

  1. 创建 PostgreSQL 数据库(空库即可),例如 start-admin-boot-dev。

    无需手动导入 SQL:项目使用 Liquibase 管理表结构,首次启动会自动建表并灌入种子数据(菜单、权限、字典等)。

  2. 启动 Redis 服务。

  3. 配置环境变量文件:start-admin-boot-backend/start-admin/ 目录下有 .env.example,复制为 .env 并按需填写:

    cd start-admin-boot-backend/start-admin
    cp .env.example .env

    .env 由 Spring 启动时自动加载(spring.config.import),无需任何插件;主要配置项:

    变量 说明
    DB_URL / DB_USERNAME / DB_PASSWORD PostgreSQL 连接信息
    REDIS_HOST / REDIS_PORT / REDIS_PASSWORD / REDIS_DATABASE Redis 连接信息
    SA_TOKEN_JWT_SECRET_KEY JWT 密钥,生产环境务必替换为长随机串

启动服务

项目提供跨平台启动脚本三件套(.ps1 / .sh / .bat),在仓库根目录运行。脚本会自动安装共享模块 start-common、传递 profile 并处理端口:

# 后端(默认 dev profile,端口 48080,上下文 /api)
./start-backend.sh start

# 前端(端口 9000,首次运行请先 pnpm install)
cd start-admin-boot-web-ui && pnpm install && cd ..
./start-frontend.sh start

Profile 强制要求:后端启动必须激活 Spring profile(dev / test / pre / prod), 否则 datasource 无 URL 会启动失败。这是配置契约的安全边界。

启动成功标志:

  • 后端:日志输出 Started StartAdminApplication in ... seconds
  • 前端:访问 http://localhost:9000

热重启

后端集成 spring-boot-devtools,监听 target/classes 下 class 变化自动热重启(约 1~2 秒):

mvn -pl start-admin compile

注意:改动 start-common 后需要重新安装共享模块(脚本的 restart 动作会自动完成),且正在运行的进程不会热加载新的 common jar,必须重启。