RuoYi Office 快速启动

本页用于把 RuoYi Office 在本地跑起来：先准备 MySQL、Redis，再启动后端 yudao-server，最后启动 PC 管理端 web-antd。如果只想快速体验，推荐先走单体模式；需要验证微服务部署时，再切换到 Gateway + 各业务服务的方式。

环境要求

环境	建议版本	说明
JDK	17	后端工程当前以 Java 17 编译
Maven	3.8+	用于后端依赖下载与构建
Node.js	20.19+	ruoyi-office-vben 当前要求 `^20.19.0
pnpm	10.x	当前仓库 packageManager 为 pnpm@10.32.1
MySQL	5.7 / 8.0+	本地建议库名 ruoyi-office
Redis	5.0+	默认 127.0.0.1:6379
Nacos	2.x	仅微服务模式必需

初始化数据库

创建数据库：

CREATE DATABASE IF NOT EXISTS `ruoyi-office`
  DEFAULT CHARACTER SET utf8mb4
  COLLATE utf8mb4_unicode_ci;

初始化 SQL 按当前交付版本选择（业务库与 XXL 调度库分开，详见 ruoyi-office-db/dump/latest/README.md）：

场景	SQL 来源	执行顺序
商业版全功能	dump/latest/ 的 schema_*.sql、static_data_*.sql	先结构，后静态数据
商业版 OA	同上 + 122012_oa_disable_non_oa_menus.sql	业务库初始化后停用非 OA 菜单
XXL-Job（可选）	xxl_job_schema.sql → xxl_job_init_all.sql 或 xxl_job_init_oa.sql	独立库 xxl_job，勿导入业务库
开源体验	ruoyi-office/sql/mysql/ 或交付包内初始化 SQL	按文件说明执行
增量升级	ruoyi-office-db/update/{YYYYMM}/{YYYYMMDD}_update/	按月、日顺序；默认只跑当日 01_apply_必跑/。完整说明见 ruoyi-office-db/docs/增量升级指南.md

默认数据库连接改你当前激活的环境配置即可（application-dev.yaml 或本机 application-local.yaml）：

spring:
  datasource:
    dynamic:
      datasource:
        master:
          url: jdbc:mysql://127.0.0.1:3306/ruoyi-office?useSSL=false&serverTimezone=Asia/Shanghai&allowPublicKeyRetrieval=true&nullCatalogMeansCurrent=true&rewriteBatchedStatements=true
          username: root
          password: 123456

local 用于本地开发调试；application-local.yaml 被 .gitignore 忽略，交付包通常没有。可直接用 dev，或复制 application-dev.yaml 为 application-local.yaml 后继续用 local。详见 快速启动文档 · local 与 dev 说明。

初始化 Redis

本地 Redis 默认配置：

spring:
  data:
    redis:
      host: 127.0.0.1
      port: 6379
      database: 0

如果 Redis 设置了密码，修改你正在使用的 application-dev.yaml 或 application-local.yaml，补充 password 即可。

启动后端

单体模式

单体模式使用 ruoyi-office/yudao-server，主类是 YudaoServerApplication。它适合开发、演示、小团队部署和客户现场快速验证。

1. 用 IDEA 打开 ruoyi-office/。
2. 等 Maven 依赖下载完成。
3. 确认环境：直接用 Active profiles = dev，或基于 dev 自建 application-local.yaml 后继续用 local。
4. 运行 yudao-server/src/main/java/cn/iocoder/yudao/server/YudaoServerApplication.java。
5. 访问 http://127.0.0.1:48080，能返回服务信息即代表后端启动成功。

命令行编译可使用：

cd ruoyi-office
mvn -P boot -DskipTests compile

微服务模式

微服务模式需要先启动 Nacos，并创建本地使用的命名空间。随后按需启动：

服务	模块	说明
Gateway	yudao-gateway	统一入口，默认端口 48080
System	yudao-module-system	用户、角色、菜单、权限、租户
Infra	yudao-module-infra	文件、代码生成、配置、任务、日志
BPM / OA / CRM 等	对应 yudao-module-*	按业务启用

命令行编译：

cd ruoyi-office
mvn -P cloud -DskipTests compile

启动 PC 管理端

PC 管理端主应用位于 ruoyi-office-vben/apps/web-antd。首次启动前先安装依赖：

cd ruoyi-office-vben
pnpm install
pnpm dev:antd

默认开发端口由 Vite 输出为准。登录页接口会请求后端 /admin-api，如本地后端端口或代理配置有变化，需要检查 apps/web-antd 下的环境变量和 Vite 代理配置。

常用命令：

pnpm dev:antd
pnpm build:antd
pnpm check:type
pnpm lint

常见问题

找不到 application-local / 启动报依赖或编译错误

local 是本地调试环境，交付包通常没有 application-local.yaml。可直接改用 dev，或复制 application-dev.yaml 为 application-local.yaml。详见 快速启动文档 Q1。

后端启动后数据库连接失败

先确认数据库名、端口、账号和密码是否与当前激活环境一致（dev / local 各自对应 yaml）。Docker MySQL 常见映射端口可能是 33061，不要和本机 3306 混淆。

前端登录提示接口不可用

检查后端是否已启动、/admin-api 是否能访问，以及前端代理是否指向 http://127.0.0.1:48080。

微服务启动后 Gateway 503

通常是业务服务没有注册到 Nacos、命名空间不一致，或服务未启动。先确认 Nacos 控制台能看到对应服务实例。

下一步

• PC 管理端单独启动细节：/quick-start/front/
• 工作流功能开启：/bpm/
• CRM 客户管理：/crm/customer/