Skip to content
Get packs

Guide · Open source

How to use yudao-cloud: clone, build and explore the modules

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

yudao-cloud is an open-source back-office management system written in Java. It is built on Spring Cloud Alibaba, MyBatis Plus and a Vue admin front end, and it is the microservice edition of the ruoyi-vue-pro family. This guide explains what the project contains, what you need before you start, how to get the code, and how to choose between the full and mini editions. It is written for readers who are comfortable with Java but may be new to this specific codebase.

yudao-cloudYunaiV/yudao-cloud · ★ 19.7k · MIT

Quick start

  1. 1Check your JDK. Confirm that you have a JDK that matches the branch you plan to use: JDK 8 for master, JDK 17 or 21 for master-jdk17, or JDK 25 for master-jdk25.
  2. 2Clone the repository. Run git clone https://github.com/YunaiV/yudao-cloud in the folder where you keep your projects.
  3. 3Switch to the right branch. If you need a branch other than the default, check it out with Git so the code matches your JDK.
  4. 4Read the quick-start guide. Open https://cloud.iocoder.cn/quick-start/ for the official build and run steps, since the README defers setup details to external docs.
  5. 5Prepare Nacos, Redis and MySQL. Set up the registry and configuration centre, cache and database the project depends on, and import the matching SQL script from the sql directory.
  6. 6Explore a live demo. Compare the admin interface with the Vue 3 or Vue 2 demo links in the README before you customise anything.

What is yudao-cloud and who is it for?

yudao-cloud is a ready-made starting codebase for business and admin software. The README describes features such as RBAC dynamic permissions, multi-tenancy, data permissions, workflow, third-party login, payments, SMS, a shop, CRM, ERP, MES, IM, AI large models and IoT.

The project suits Java teams building internal business systems, developers who want a microservice reference on Spring Cloud Alibaba, and companies that need multi-tenant admin backends. It is less suited to beginners without Java or Spring experience, small projects, or teams that want a non-Java stack.

  • Best for: Java teams building internal business or admin systems
  • Best for: developers who want a Spring Cloud Alibaba microservice reference
  • Not for: small projects that only need a simple website or single app
  • Not for: teams that want a non-Java stack

What do you need before you install yudao-cloud?

You need the Java Development Kit (JDK) and Git. The JDK version depends on which branch you use: the master branch targets JDK 8, master-jdk17 targets JDK 17 or 21, and master-jdk25 targets JDK 25.

The stack also has many moving parts. The README lists Nacos for registry and configuration, Redis, and MySQL, among other components such as XXL-Job, Sentinel, Gateway and Seata. Plan time for setting these up before you expect the system to run.

  • JDK matching your chosen branch
  • Git
  • Nacos (registry and configuration centre)
  • Redis and MySQL (the default database is MySQL)

How do you get the yudao-cloud code?

The install method is clone-and-build. Clone the repository from GitHub with the command below. The README also links a Gitee mirror of the full edition.

Before you clone, decide which branch you need so the JDK you install matches it. Check out the branch with Git after cloning if it is not the default one.

git clone https://github.com/YunaiV/yudao-cloud

How do you choose between the full and mini editions?

yudao-cloud is the full edition. It includes system functions, infrastructure, workflow, payments, reporting, WeChat Official Account, shop, member centre, ERP, WMS, CRM, MES, HRM, FMS, PMS, OA, AI large models, IoT and IM.

yudao-cloud-mini is the slimmed-down edition. It contains only system and infrastructure functions. The README provides a migration document for moving from the full edition to the mini edition, which it says takes 5 to 10 minutes.

  • Full edition (yudao-cloud): all modules listed above
  • Mini edition (yudao-cloud-mini): system and infrastructure only
  • Migration guide: https://cloud.iocoder.cn/migrate-module/

Where do you find setup steps and tutorials?

The README points to a quick-start guide for setting the project up, as well as a video tutorial series and several live demos of the admin front end. The front end is available in Vue 3 with element-plus, Vue 3 with vben (ant-design-vue), and Vue 2 with element-ui.

The README says the project is documented in external resources, so use the official links for the exact build and run steps rather than relying on memory or third-party posts.

  • Quick start: https://cloud.iocoder.cn/quick-start/
  • Video tutorials: https://cloud.iocoder.cn/video/
  • Linux deployment: https://cloud.iocoder.cn/deployment-linux/
  • Database notes: https://cloud.iocoder.cn/xinchuang-db/

How do you work with the database and domestic platforms?

The sql directory contains initialisation scripts for MySQL, Oracle, PostgreSQL, SQL Server, Dameng, KingbaseES and openGauss, along with Quartz scripts. MariaDB and TiDB use the MySQL scripts directly. The README also lists domestic operating systems, caches and application servers as supported in localised environments.

Other databases or later schema changes can be handled with the converters in sql/tools, but the README notes that converted schemas still need adjusting and testing for your actual database.

  • Default database: MySQL
  • Scripts are in the sql directory; use the folder matching your database
  • Converted schemas must be tested before use

What people use it for

  • An internal business system with role-based permissions and multiple user types
  • A multi-tenant admin backend where each tenant has its own permission set
  • A microservice reference project on Spring Cloud Alibaba for a Java team
  • A back-office base for CRM, ERP or workflow-driven processes, using only the modules you need

Frequently asked questions

Is yudao-cloud free to use?

Yes. The repository is listed under the MIT licence, and the README states that there will be no commercial edition and that all code is open source. The README says individuals and companies can use it 100% free of charge.

What do I need to install yudao-cloud?

You need the JDK and Git. The JDK version depends on the branch: JDK 8 for master, JDK 17 or 21 for master-jdk17, and JDK 25 for master-jdk25. The stack also uses Nacos, Redis and MySQL, so those services must be available.

How do I install yudao-cloud?

Clone the repository with git clone https://github.com/YunaiV/yudao-cloud, then follow the official quick-start guide at https://cloud.iocoder.cn/quick-start/ for the build and run steps. The README does not spell out the full build commands itself.

What is the difference between yudao-cloud and yudao-cloud-mini?

yudao-cloud is the full edition with workflow, payments, shop, CRM, ERP, IoT, AI and other business modules. yudao-cloud-mini keeps only the system and infrastructure functions. The README provides a migration guide for moving from the full to the mini edition.

How does yudao-cloud compare with ruoyi-vue-pro or RuoYi-Vue?

The README describes ruoyi-vue-pro as a Spring Boot multi-module project and yudao-cloud as a Spring Cloud microservice project. The README links a community comparison table for the Chinese open-source admin projects. Choose based on whether you want microservices or a simpler module layout.

Where can I get help if the build or run fails?

Start with the quick-start guide and the video tutorials linked in the README. For questions or feature requests, the README says you can raise them in the project's Issues section.

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

yudao-cloud suits Java teams that want a large, MIT-licensed microservice codebase for business or multi-tenant admin systems, and that are ready to run Nacos, Redis and MySQL. If you are new to Java or Spring, need only a simple site or small app, or want a non-Java stack, a smaller project such as ruoyi-vue-pro, or a different framework, will be a better fit.

Install options & downloads