跳转到内容

安装

这是完整的本地安装:前置条件、获取代码、运行后端与 Vue 管理端。如果你只想快速跑起后端及其 OpenAPI 浏览器,快速开始 更短。

工具版本用于
JDK21后端(默认且唯一支持的大版本)
Maven3.9+构建后端
Docker任意较新版本MySQL + Redis(可选 PostgreSQL / MinIO)
Node.js24>=24 <27管理端
pnpm11管理端包管理器

StackRivet 是多仓库工作区:后端与管理端是两个独立的 git 仓库,并排克隆。(这与项目”不做 monorepo”的结构一致——每个仓库有自己的发布节奏和许可。)

Terminal window
git clone https://github.com/zkmall/stackrivet-server.git
git clone https://github.com/zkmall/stackrivet-admin-ui.git

也可以使用 Gitee 镜像:

Terminal window
git clone https://gitee.com/zkmall/stackrivet-server.git
git clone https://gitee.com/zkmall/stackrivet-admin-ui.git

把两个仓库作为同级目录放在同一父文件夹下;管理端默认后端就在其同级目录。

stackrivet-server 中启动 MySQL 和 Redis。Redis 支撑 JWT 吊销和 Actuator 健康检查,因此是必需的。

Terminal window
cd stackrivet-server
docker compose up -d mysql redis

仅当设置 STACKRIVET_DB_VENDOR=postgresql 时才加 postgres;仅当设置 STACKRIVET_STORAGE_TYPE=s3 时才加 minio

Terminal window
mvn install -DskipTests=true # 一次性构建全部 16 个模块
mvn -pl stackrivet-app spring-boot:run # 运行 Spring Boot 应用

API 在 8080 端口启动。打开 OpenAPI 浏览器确认:

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

(在 Linux 或 Windows 上,在浏览器访问该 URL。)

stackrivet-admin-ui 仓库中:

Terminal window
cd stackrivet-admin-ui
pnpm install
pnpm dev # http://127.0.0.1:5173/

dev server 把 /api/*/actuator/* 代理到 8080 端口的后端,所以先启动后端。你也可以打开设计系统展示页 http://127.0.0.1:5173/design-system

后端从环境变量读取数据库和存储设置,并带合理的本地默认值:

变量用途示例
STACKRIVET_DB_VENDOR数据库方言mysql(默认)/ postgresql
STACKRIVET_STORAGE_TYPEAsset Service 后端local(默认)/ s3 / aliyun_oss

常用环境变量见配置

  • 项目结构 —— 仓库和模块如何组合在一起。
  • 架构 —— 模块化单体设计与模块边界。