From 753bea5998960e7c7d02acefad61c900f7084c10 Mon Sep 17 00:00:00 2001 From: "Ray.Hao" <1490493387@qq.com> Date: Sun, 19 Jul 2026 09:38:43 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E7=BB=9F=E4=B8=80=E5=90=8E=E7=AB=AF?= =?UTF-8?q?=E7=94=9F=E6=80=81=E7=9F=A9=E9=98=B5=EF=BC=88=E8=A1=A5=20FastAP?= =?UTF-8?q?I=E3=80=81=E4=BF=AE=E6=AD=A3=E5=9D=8F=E9=93=BE=E3=80=81?= =?UTF-8?q?=E7=BB=9F=E4=B8=80=208=20=E8=A1=8C=E9=A1=BA=E5=BA=8F=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 补齐 FastAPI、修正 youlai-thinkphp/youlai-rust 坏链 - 统一 8 行顺序：boot/nest/gin/django/fastapi/think/aspnet/axum - 计数由七种改为八种后端 --- README.en.md | 185 +++++++++++++++++++++++++++++++++++++++++++++++++-- README.md | 7 +- 2 files changed, 184 insertions(+), 8 deletions(-) diff --git a/README.en.md b/README.en.md index 37955ce0..1cc3a0bb 100644 --- a/README.en.md +++ b/README.en.md @@ -1,186 +1,361 @@
+ + # youlai-boot youlai-boot + + **Enterprise-grade permission management backend based on Spring Boot 4** + + [![Spring Boot](https://img.shields.io/badge/Spring%20Boot-4.0.5-6DB33F?logo=spring-boot)](https://spring.io/projects/spring-boot) + [![JDK](https://img.shields.io/badge/JDK-17%2B-007396?logo=openjdk)](https://openjdk.org/) + [![License](https://img.shields.io/badge/License-Apache%202.0-blue?logo=apache)](LICENSE) + [![Gitee Star](https://gitee.com/youlaiorg/youlai-boot/badge/star.svg)](https://gitee.com/youlaiorg/youlai-boot/stargazers) + [![GitHub Star](https://img.shields.io/github/stars/youlaitech/youlai-boot?style=social)](https://github.com/youlaitech/youlai-boot) + [![GitCode Star](https://gitcode.com/youlai/youlai-boot/star/badge.svg)](https://gitcode.com/youlai/youlai-boot/stargazers) + +
+ + ![](https://foruda.gitee.com/images/1708618984641188532/a7cca095_716974.png "rainbow.png") + +
+ + [![Live Preview](https://img.shields.io/badge/Live%20Preview-2D8CF0?style=for-the-badge&logo=google-chrome&logoColor=white)](https://vue.youlai.tech) + [![Mobile Preview](https://img.shields.io/badge/Mobile%20Preview-19BE6B?style=for-the-badge&logo=android&logoColor=white)](https://app.youlai.tech) + [![Documentation](https://img.shields.io/badge/Documentation-8B5CF6?style=for-the-badge&logo=gitbook&logoColor=white)](https://www.youlai.tech/docs/server/spring-boot/) + [![简体中文](https://img.shields.io/badge/简体中文-00B4D8?style=for-the-badge&logo=google-translate&logoColor=white)](./README.md) + +
+ + ## Introduction + + **youlai-boot** is an enterprise-grade permission management backend built on Spring Boot 4. It ships with the frontend [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) and the mobile app [youlai-app](https://gitee.com/youlaiorg/youlai-app), and is one of **7 language implementations** (Java / Node.js / Go / Python / PHP / C# / Rust) that share the same API specification and database schema. It is suitable for learning, reference, and secondary development of enterprise admin systems. + + ## Core Features + + - 🔐 **Security** — Spring Security + JWT/Redis dual-session model, token renewal, multi-device mutual exclusion + - 🛡️ **Fine-grained permissions** — 5-level RBAC: data → menu → button → API → field + - ⚡ **Code generator** — one-click generation of full-stack CRUD code + - 📦 **Complete modules** — users, roles, menus, departments, dictionaries, files, scheduled tasks, message center, operation logs + - 🌐 **Multi-tenant SaaS** — data isolation + tenant config, with a standalone [youlai-boot-tenant](https://gitee.com/youlaiorg/youlai-boot-tenant) edition + - 🔌 **Real-time communication** — SSE push: online user count, dictionary sync, notification broadcast + + ## System Preview + + **PC** + + + + + + + + + + + + + + +
PC Preview 1PC Preview 2
PC Preview 3PC Preview 4
PC Preview 5PC Preview 6
+ + **Mobile** + + + + + + + + +
App Preview 1App Preview 2App Preview 3App Preview 4
+ + ## Quick Start + + **Requirements**: JDK 17+ · MySQL 8.0+ · Redis 6.0+ + + 1. Clone: `git clone https://gitee.com/youlaiorg/youlai-boot.git` + 2. Import database: `sql/youlai-admin.sql` + 3. Adjust config (optional, a read-only online data source is configured by default): `src/main/resources/application-dev.yml` + 4. Start and visit http://localhost:8000/doc.html + + Default credentials: `admin` / `123456` + + Detailed guide: https://www.youlai.tech/docs/server/spring-boot/quick-start.html + + ## Tech Stack + + | Tech | Version | Description | + |:-----|:--------|:------------| + | Spring Boot | 4.0.5 | Core framework | + | Spring Security | 6.x | Auth & authorization | + | MyBatis-Plus | 3.5.15 | ORM | + | Druid | 1.2.24 | Connection pool | + | Redis + Redisson | 6.0+ / 4.1.0 | Cache · Session · Distributed lock | + | Caffeine | 2.9.3 | Local cache | + | XXL-Job | 3.2.0 | Distributed scheduled tasks | + | Knife4j | 4.5.0 | API docs | + | MapStruct | 1.6.3 | Object mapping | + | MinIO | 8.5.10 | Object storage | + + ## Directory Structure + + ``` + youlai-boot/ + ├── deploy/ + │ └── docker/ # Docker orchestration + ├── docs/ # Docs and image assets + ├── sql/ # Database init scripts + ├── src/ # Source code + │ ├── YouLaiBootApplication.java # Bootstrap class + │ ├── auth/ # Auth (login/logout/token) + │ ├── codegen/ # Code generator + │ ├── common/ # Common module (constants/enums/response) + │ ├── file/ # File service (MinIO/local/OSS) + │ ├── framework/ # Technical framework layer + │ │ ├── apidoc/ # OpenAPI / Knife4j + │ │ ├── cache/ # Redis / Caffeine cache + │ │ ├── captcha/ # Graphic captcha + │ │ ├── integration/ # SMS / Email / WeChat + │ │ ├── job/ # XXL-Job scheduled tasks + │ │ ├── mybatis/ # MyBatis-Plus config + │ │ ├── security/ # Security / JWT / Token + │ │ └── web/ # Global exception / CORS / rate limit + │ ├── message/ # SSE push + │ └── system/ # Business (user/role/menu/dept) + └── pom.xml # Maven dependency management + ``` + + ## Ecosystem + + **Frontend** + + | Project | Stack | Description | + |:-----|:------|:------------| + | [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | Vue 3 + Element Plus | PC admin frontend (recommended) | + | [youlai-app](https://gitee.com/youlaiorg/youlai-app) | Vue 3 + UniApp | Mobile App | + + **Backend** + + | Project | Stack | Description | -|:-----|:------|:------------| +| [youlai-boot](https://gitee.com/youlaiorg/youlai-boot) | Spring Boot 4 + MyBatis-Plus | Java (recommended) | | [youlai-nest](https://gitee.com/youlaiorg/youlai-nest) | NestJS + TypeORM | Node.js | | [youlai-gin](https://gitee.com/youlaiorg/youlai-gin) | Go + Gorm | Go | | [youlai-django](https://gitee.com/youlaiorg/youlai-django) | Django + DRF | Python | | [youlai-fastapi](https://gitee.com/youlaiorg/youlai-fastapi) | FastAPI + SQLAlchemy | Python | -| [youlai-thinkphp](https://gitee.com/youlaiorg/youlai-thinkphp) | ThinkPHP 8 | PHP | +| [youlai-think](https://gitee.com/youlaiorg/youlai-think) | ThinkPHP 8 | PHP | | [youlai-aspnet](https://gitee.com/youlaiorg/youlai-aspnet) | ASP.NET Core | C# | -| [youlai-rust](https://gitee.com/youlaiorg/youlai-rust) | Axum + SeaORM | Rust | - +| [youlai-axum](https://gitee.com/youlaiorg/youlai-axum) | Axum + SeaORM | Rust | > **youlai-boot** also provides the following variants and branches: [Multi-Tenant](https://gitee.com/youlaiorg/youlai-boot-tenant) (Spring Boot 4) · [MyBatis-Flex](https://gitee.com/youlaiorg/youlai-boot-flex) (Spring Boot 4) · [Spring Boot 3](https://gitee.com/youlaiorg/youlai-boot/tree/spring-boot-3) · [PostgreSQL](https://gitee.com/youlaiorg/youlai-boot/tree/db-pg) · [Multi-Module](https://gitee.com/youlaiorg/youlai-boot/tree/multi-module) + > -> The seven backends share the same **RESTful API specification** and **database schema**, so the frontend can switch seamlessly. + +> The eight backends share the same **RESTful API specification** and **database schema**, so the frontend can switch seamlessly. + + ## Documentation + + | Resource | Link | + |:-----|:-----| + | 📖 Full docs site | [www.youlai.tech](https://www.youlai.tech/) | + | 🖥️ PC live preview | [vue.youlai.tech](https://vue.youlai.tech) | + | 📱 Mobile live preview | [app.youlai.tech](https://app.youlai.tech) | + | 🔗 Apifox API docs | [apifox.com](https://www.apifox.cn/apidoc/shared-195e783f-4d85-4235-a038-eec696de4ea5) | + | 🔗 Local API docs | [localhost:8000/doc.html](http://localhost:8000/doc.html) | + + ## License + + Released under the [Apache License 2.0](LICENSE); free for commercial use. + + --- + + + + + + + + + +
+ Official WeChat Account
+ Official WeChat Account + 		     + Mini Program
+ Mini Program + 		     + Add author on WeChat
+ Add author on WeChat +
+ +

Technical discussion · Feedback · Business cooperation

+ diff --git a/README.md b/README.md index e441f02f..589100ff 100644 --- a/README.md +++ b/README.md @@ -121,17 +121,18 @@ youlai-boot/ | 项目 | 技术栈 | 说明 | |:-----|:-------|:-----| +| [youlai-boot](https://gitee.com/youlaiorg/youlai-boot) | Spring Boot 4 + MyBatis-Plus | Java（主推） | | [youlai-nest](https://gitee.com/youlaiorg/youlai-nest) | NestJS + TypeORM | Node.js | | [youlai-gin](https://gitee.com/youlaiorg/youlai-gin) | Go + Gorm | Go | | [youlai-django](https://gitee.com/youlaiorg/youlai-django) | Django + DRF | Python | | [youlai-fastapi](https://gitee.com/youlaiorg/youlai-fastapi) | FastAPI + SQLAlchemy | Python | -| [youlai-thinkphp](https://gitee.com/youlaiorg/youlai-thinkphp) | ThinkPHP 8 | PHP | +| [youlai-think](https://gitee.com/youlaiorg/youlai-think) | ThinkPHP 8 | PHP | | [youlai-aspnet](https://gitee.com/youlaiorg/youlai-aspnet) | ASP.NET Core | C# | -| [youlai-rust](https://gitee.com/youlaiorg/youlai-rust) | Axum + SeaORM | Rust | +| [youlai-axum](https://gitee.com/youlaiorg/youlai-axum) | Axum + SeaORM | Rust | > **youlai-boot** 还提供以下变种和分支版本：[多租户](https://gitee.com/youlaiorg/youlai-boot-tenant)（Spring Boot 4）· [MyBatis-Flex](https://gitee.com/youlaiorg/youlai-boot-flex)（Spring Boot 4）· [Spring Boot 3](https://gitee.com/youlaiorg/youlai-boot/tree/spring-boot-3) · [PostgreSQL](https://gitee.com/youlaiorg/youlai-boot/tree/db-pg) · [多模块](https://gitee.com/youlaiorg/youlai-boot/tree/multi-module) > -> 七种后端共享同一套 **RESTful API 规范** 和 **数据库结构**，前端可无缝切换。 +> 八种后端共享同一套 **RESTful API 规范** 和 **数据库结构**，前端可无缝切换。 ## 交流合作