Skip to content
Get packs

Guide · Open source

How to use ruoyi-vue-pro: setup, editions and first steps

Updated · written with AI from the project's own documentation and checked against our catalogue data

ruoyi-vue-pro is an open-source back-office admin system built on Spring Boot, MyBatis Plus and Vue, licensed under MIT. This guide explains how to choose the right edition and branch, what you need installed before you start, and where to go next to run it. It is written for readers who want to decide whether to use it and get a first copy running.

ruoyi-vue-proYunaiV/ruoyi-vue-pro · ★ 40.2k · MIT

Quick start

  1. 1Pick an edition. Choose the full edition for many built-in modules or the mini edition for only system and infrastructure features.
  2. 2Match your JDK to a branch. Use master for JDK 8, master-jdk17 for JDK 17/21, or master-jdk25 for JDK 25.
  3. 3Install prerequisites. Install the matching JDK, MySQL as the default database, and Redis.
  4. 4Clone the repository. Run git clone https://github.com/YunaiV/ruoyi-vue-pro in your working folder.
  5. 5Follow the quick-start guide. Use the official quick-start page to import the database scripts, configure the project and start it.
  6. 6Explore the demo and generator. Check the demo sites for the UI and try the code generator on a table of your own.

What ruoyi-vue-pro is and who it suits

ruoyi-vue-pro is a Java admin system that includes login, RBAC dynamic permissions, data-level permissions, SaaS multi-tenancy and Flowable workflow, along with optional modules for payment, SMS, e-commerce, CRM, ERP, IoT and AI. The README describes it as a base for building back-office systems.

It fits Java developers building internal admin or back-office tools, and teams that want login, permissions and workflow already in place. It is less suitable for non-Java teams or for small projects that only need a few pages.

  • Good fit: Java back-office systems, multi-tenant admin products, CRUD-heavy internal tools
  • Poor fit: non-Java teams, simple websites, projects that need the lightest possible codebase

Choose the edition and JDK branch

The project has a full edition (ruoyi-vue-pro) and a mini edition (yudao-boot-mini). The full edition includes workflow, payment, reporting, mall, ERP, CRM, MES, AI, IoT and IM modules. The mini edition only includes system and infrastructure features. The README notes that the full edition can be migrated to the mini edition using the migration guide.

Branches depend on your JDK. The master branch uses JDK 8 with Spring Boot 2.7, master-jdk17 uses JDK 17/21 with Spring Boot 3.5, and master-jdk25 uses JDK 25 with Spring Boot 4.x. Pick the branch that matches the JDK you can install.

  • JDK 8 + Spring Boot 2.7: master branch
  • JDK 17/21 + Spring Boot 3.5: master-jdk17 branch
  • JDK 25 + Spring Boot 4.x: master-jdk25 branch

Install prerequisites

Before building, install the JDK version that matches your chosen branch. The default database is MySQL, and Redis is used for caching and authentication tokens. The source also lists MariaDB, Oracle, PostgreSQL, SQL Server and several domestic databases, and provides SQL initialisation scripts in the sql directory.

For the default setup, use the MySQL scripts from the sql directory. Other databases have their own folders, and the README advises using the matching folder where one exists.

  • JDK matching your branch (8, 17/21 or 25)
  • MySQL as the default database
  • Redis

Clone the repository

The README gives the clone command below. Run it in the folder where you want the project to live, then open the project in your Java IDE. The repository is hosted on GitHub; a Gitee mirror is also listed in the README.

To use a non-default branch, check out the branch that matches your JDK after cloning. The README links each branch on the Gitee repository.

git clone https://github.com/YunaiV/ruoyi-vue-pro

Build and start the project

The source names the install method as clone-and-build but the README excerpt does not include the build or run commands. Follow the quick-start guide at the official documentation site for the exact steps for your branch, including database import and configuration.

The README also links to demo sites for the Vue 3 element-plus, Vue 3 vben and Vue 2 element-ui front ends, so you can see the admin UI before running your own copy.

  • Quick-start guide: https://doc.iocoder.cn/quick-start/
  • Video tutorials: https://doc.iocoder.cn/video/
  • Front-end options: Vue 3 + element-plus, Vue 3 + vben (ant-design-vue), Vue 2 + element-ui

Use the code generator and extend it

The README says the code generator can produce Java and Vue front-end code, SQL scripts and API documentation from database tables. It supports single tables, tree tables and master-detail tables. Developers typically use this to scaffold CRUD pages and then adapt the generated code to their needs.

Because ruoyi-vue-pro is a starting point, most teams spend their effort adapting permissions, modules and workflows to their own business rules.

  • Generates Java and Vue code, SQL and API docs
  • Supports single, tree and master-detail tables

What people use it for

  • Internal back-office systems with users, roles and menus
  • Multi-tenant SaaS admin products where each tenant has its own permissions
  • Approval flows built on Flowable workflow
  • CRUD admin pages generated from database tables
  • Projects that combine admin backends with a WeChat mini program

Frequently asked questions

Is ruoyi-vue-pro free to use?

The README states that ruoyi-vue-pro is open source under the MIT licence and that there will be no commercial version. It says individuals and companies can use it free of charge.

What do I need to install before running ruoyi-vue-pro?

You need a JDK that matches your chosen branch (8, 17/21 or 25), MySQL as the default database, and Redis. The README lists these as the prerequisites.

Which branch should I use?

Choose by JDK version: master for JDK 8 with Spring Boot 2.7, master-jdk17 for JDK 17/21 with Spring Boot 3.5, and master-jdk25 for JDK 25 with Spring Boot 4.x.

What is the difference between ruoyi-vue-pro and the mini edition?

The full edition includes many modules such as workflow, payment, mall, ERP, CRM and AI. The mini edition (yudao-boot-mini) only includes system and infrastructure features.

How does ruoyi-vue-pro compare to RuoYi-Vue or other admin projects?

The source names RuoYi-Vue, Jeecg-Boot, Spring Boot Admin and vue-element-admin as comparable projects, and points to a community comparison table. This guide does not rate them, so check that table for feature-by-feature detail.

Can I use ruoyi-vue-pro with a database other than MySQL?

Yes. The README lists Oracle, PostgreSQL, SQL Server, MariaDB and several domestic databases, with matching folders in the sql directory. It notes that converted scripts still need adjustment and testing for your database.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

ruoyi-vue-pro suits Java teams that want a large, ready-made admin base with permissions, multi-tenancy and workflow already included, and it is free under MIT. Teams without Java experience, or those building a small site or a very light admin tool, should consider a smaller project or the mini edition instead.

Install options & downloads