# ruoyi-rust

**Repository Path**: rustdev/ruoyi-rust

## Basic Information

- **Project Name**: ruoyi-rust
- **Description**: RuoYi-Rust(tokio，axum)是一个雄心勃勃的项目，旨在通过现代、高性能的 Rust 语言及其强大的生态系统，完整重写主流Ruoyi的Java Web 框架 后端服务
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 136
- **Forks**: 48
- **Created**: 2025-09-09
- **Last Updated**: 2026-09-11

## Categories & Tags

**Categories**: backend

**Tags**: None

## README

# RuoYi-Rust Monorepo

RuoYi-Rust 是面向业务开发的 Rust 全栈管理框架。仓库将 Rust 后端与 Vue Vben 管理端放在同一 Git 仓库中，便于统一维护接口契约、迁移、文档和 AI 协作规则。

## 目录

```text
backend/       Rust Cargo Workspace（Axum + SeaORM）
frontend/      Vue 3 + TypeScript + Vben Admin pnpm Workspace
mobile/        后续移动端预留目录
docs/          架构、部署、业务设计与 AI Skill 文档
.agent/        项目级 AI 规则与 Skill 唯一维护源
AGENTS.md      跨 AI 协作入口
```

## 本地开发

### 后端

```bash
cd backend
cp config/default.toml config/local.toml
# 按本机环境修改 config/local.toml 的数据库与服务配置
cargo run -p app
```

默认 API 前缀为 `/prod-api`，OpenAPI 文档为：

```text
http://localhost:8080/prod-api/openapi.json
```

### 前端

```bash
cd frontend
pnpm install
pnpm -F @vben/web-ele run dev
```

前端 API 地址和代理配置以 `frontend/apps/web-ele/.env.*` 与实际 Vite 配置为准。

## 验证

```bash
# 后端：Windows 环境优先使用净化环境脚本
cd backend
bash scripts/cargo-check-clean-env.sh -p framework -p system -p app

# 前端：针对当前管理端进行类型检查
cd frontend
pnpm -F @vben/web-ele run typecheck
```

## AI 协作与 Skills

先阅读根目录 [`AGENTS.md`](AGENTS.md)，再按任务读取：

- [`backend/CLAUDE.md`](backend/CLAUDE.md)：Rust API 序列化与后端局部规则；
- [`frontend/CLAUDE.md`](frontend/CLAUDE.md)：Vben Workspace、组件和 pnpm 规则；
- [`.agent/AGENTS.md`](.agent/AGENTS.md)：项目级 AI 全局约束；
- [`.agent/skills/`](.agent/skills/)：可发布到各 AI 工具目录的唯一 Skill 源；
- [`docs/AI技能/`](docs/AI技能/)：项目能力、设计和操作说明类 Skill 文档。

`.claude/`、`.codex/`、`.cursor/`、`.trae/`、`.aone_copilot/` 必须保留，以便各工具发现项目 Skills；它们由 `.agent/` 源统一发布，禁止作为独立维护源。