跳转到内容

快速开始

本指南在本地把 StackRivet 后端连同 OpenAPI 浏览器跑起来,前提是你已经检出了 stackrivet-server 仓库。完整安装——克隆各仓库、运行管理端、配置——见安装

  • JDK 21(默认支持的大版本;重大框架升级使用独立分支)
  • Maven 3.9+
  • Docker —— 用于在本地运行 MySQL 和 Redis

默认 profile 使用 MySQL + Redis。Redis 支撑 JWT 吊销和 Actuator 健康检查,因此是必需的。

Terminal window
docker compose up -d mysql redis

仅当设置 STACKRIVET_DB_VENDOR=postgresql 时才需加 postgres;仅当设置 STACKRIVET_STORAGE_TYPE=s3 时才需加 minio。常用环境变量见配置

后端是由 16 个 Maven 模块组成的模块化单体。先整体构建一次:

Terminal window
mvn install -DskipTests=true

stackrivet-app 是 Spring Boot 入口,把每个业务模块装配成可运行的应用:

Terminal window
mvn -pl stackrivet-app spring-boot:run

应用启动后,打开交互式 API 文档:

Terminal window
open http://127.0.0.1:8080/swagger-ui.html

在 Linux 或 Windows 上,直接在浏览器访问 http://127.0.0.1:8080/swagger-ui.html

要使用 Vue 管理界面,从 stackrivet-admin-ui 仓库启动前端(它会把 /api/*/actuator/* 代理到 8080 端口的后端):

Terminal window
pnpm install
pnpm dev # http://127.0.0.1:5173/

需要 Node 24pnpm 11

  • 项目结构 —— 仓库和模块如何组合在一起。

继续阅读生成模块、配置对象存储和部署指南。