Go to file

gitee-agent 14925fa45e Pre Merge pull request !6 from gitee-agent/N/A		2025-06-26 07:15:29 +00:00
.codelf	optimize: 优化代码质量	2025-05-13 23:13:23 +08:00
.gitee	docs: 新增部署工作流	2025-05-30 18:08:27 +08:00
.github	docs(projects): 修改部署工作流与项目说明文件	2025-06-06 09:36:29 +08:00
.vscode	feat: 接入tinymce富文本	2025-05-13 17:41:29 +08:00
build	fix: 修复打包问题	2025-05-16 12:09:10 +08:00
docs	feat: 添加选择列	2025-05-29 17:22:24 +08:00
packages	Merge remote-tracking branch 'soybeanjs/main' into dev	2025-05-28 12:01:36 +08:00
public	chore: 重构 tinymce 组件	2025-05-13 21:59:11 +08:00
src	fix(styles): 添加滚动条，去除页码	2025-06-06 13:07:21 +08:00
.drone.yml	docs: 新增部署脚本	2025-06-03 11:37:01 +08:00
.editorconfig	chore(projects): use eslint flat config & update config	2023-12-14 21:00:53 +08:00
.env	feat: 新增开启水印环境变量	2025-05-09 16:38:29 +08:00
.env.dev	feat: 适配初始菜单 SQL	2025-05-15 22:05:43 +08:00
.env.prod	feat: 新增开启水印环境变量	2025-05-09 16:38:29 +08:00
.env.test	feat: 新增开启水印环境变量	2025-05-09 16:38:29 +08:00
.gitattributes	chore(projects): add .gitattributes	2024-03-28 00:37:58 +08:00
.gitignore	feat(projects): 1.0 beta	2023-11-17 10:25:32 +08:00
.npmrc	chore(projects): update .npmrc	2024-04-27 13:47:53 +08:00
CHANGELOG.md	chore(projects): release v1.0.0	2025-06-05 22:07:48 +08:00
eslint.config.js	fix(projects): fix register name, CodeLogin => Register (#478 )	2024-06-06 15:57:58 +08:00
index.html	feat: 整合登录	2024-08-16 16:33:11 +08:00
LICENSE	update LICENSE.	2025-05-09 05:41:43 +00:00
package.json	chore(projects): release v1.0.0	2025-06-05 22:07:48 +08:00
pnpm-lock.yaml	merge: Merge soybean.	2025-05-16 16:48:05 +08:00
pnpm-workspace.yaml	feat(projects): 1.0 beta	2023-11-17 10:25:32 +08:00
README.md	Update README.md	2025-06-26 07:15:28 +00:00
tsconfig.json	chore(projects): update deps & update pnpm version & update eslint config	2024-04-23 11:20:55 +08:00
uno.config.ts	chore(projects): update unocss preset (#712 )	2025-03-06 18:17:44 +08:00
vite.config.ts	chore(projects): update deps & fix vite config	2024-12-16 16:16:08 +08:00

README.md

RuoYi-Plus-Soybean

📢 重要通知

开发前请务必查看相关指南和文档，确保遵循项目规范和流程。

📋 项目概述

RuoYi-Plus-Soybean 是一个基于 RuoYi-Vue-Plus 的前端-后端一体化项目，旨在提供高效、可扩展的开发框架。它结合了现代前端技术和完善的后端架构，适用于企业级应用开发。

🌟 项目特点

模块化架构：便于组件复用与管理。
完善的构建系统：支持多环境构建，包括开发、测试和生产版本。
代码规范：集成 ESLint、UnoCSS 等工具，确保代码风格统一。
国际化支持：内置多语言功能，适配不同地区用户。
状态管理：使用现代状态管理工具，简化数据流管理。
主题定制：支持多种颜色调色板，提供灵活的 UI 定制能力。

🛠️ 技术栈

前端

Vue 3
TypeScript
UnoCSS
Vite
Tinymce（富文本编辑器）
可选模块：Alova、Axios、@ofetch <20>
UI 组件：Material UI、Monaco Editor、SVG Icon Render

后端

兼容 RuoYi-Vue-Plus，提供标准化 API 接口与服务端交互。

🏗️ 项目结构

packages/: 包含多个可复用模块（如 alova、axios、color、hooks、materials、scripts、tinymce）。
build/: 项目构建配置与插件。
docs/: 开发文档与代码模板，包含 SQL、Java 工具类等。
.codelf/: 项目规范文档（如开发指南、性能安全规范等）。

🚀 环境要求与安装

环境要求

Node.js >= 18.x
npm 或 pnpm
RuoYi 后端服务环境（如数据库、Spring Boot）

安装步骤及说明

克隆项目：

git clone https://gitee.com/xlsea/ruoyi-plus-soybean.git
cd ruoyi-plus-soybean

安装依赖：
```
pnpm install
```
启动开发服务器：
```
pnpm dev
```
构建生产版本：
```
pnpm build
```

📝 开发指南

可用的脚本命令

pnpm dev: 启动开发环境
pnpm build: 构建生产版本
pnpm build:dev: 构建开发版本
pnpm build:test: 构build/test: 构建测试版本
pnpm preview: 预览构建结果
pnpm lint: 检查代码规范
pnpm typecheck: 类型检查
pnpm changelog: 生成更新日志
pnpm release: 发布新版本

路由生成

使用 packages/scripts 提供的路由生成工具自动创建路由结构。

提交代码

使用 git commit 前请确保代码规范检查通过。
提交信息需遵循规范（中文或英文）。

💎 特性与功能

前端特性

UnoCSS：原子化 CSS，提升开发效率。
Tinymce：富文本编辑器支持多语言和插件扩展。
状态管理：基于 modern 体系的状态管理机制。
主题系统：支持 Ant Design 调色板与自定义推荐色系。

业务功能

集成菜单管理、页面 tab、权限控制、代码生成等企业级功能。
支持 API 规范化管理与 Typing 声明。

🤝 贡献指南

欢迎贡献代码！请遵循以下流程：

Fork 项目并创建新分支。
修改代码并运行测试。
提交 PR，填写规范的 Pull Request 模板。

提交规范

使用符合 conventional commit 的格式。
提交前请运行 pnpm lint 与 pnpm typecheck 确保代码质量。

📄 许可证

本项目遵循 MIT License，详情请参见仓库根目录的 LICENSE 文件。

🔗 相关链接

项目主页：Gitee 仓库
文档：docs
Issues 跟踪：Bug 报告 | 功能请求

📬 联系方式

作者：xlsea
开发交流群：请加入 Gitee 项目讨论区或 issue 反馈
捐赠作者：如有需要，可通过项目页面支持作者开发

RuoYi-Plus-Soybean 致力于打造高效、可维护、可扩展的企业级开发框架。欢迎使用并参与共建！

README.md Unescape Escape