README

SoybeanAdmin
  中文 | English


---








  
  


 [!NOTE]
 如果您觉得 SoybeanAdmin对您有所帮助，或者您喜欢我们的项目，请在 GitHub 上给我们一个 ⭐️。您的支持是我们持续改进和增加新功能的动力！感谢您的支持！

 [!NOTE]
 SoybeanAdmin 快速上手系列视频已在 Bilibili 上线 点击这里 前往查看

 [!IMPORTANT]
 SoybeanAdmin 3.0 版本正在开发中，将基于 ubean 全栈框架与 VeanUI 组件库进行整体重构，进展与方案请查看 Roadmap Issue 941。

 [!WARNING]
 2.3 将是 2.x 系列最后一个维护的大版本。2.x 后续只在该版本上提供维护更新，新特性将集中在 3.0 中实现，建议新项目关注 3.0 进展。


  
    
      
        
          
            
              
                
              
            
            
              
                
              
            
          
        
        面向 Vue 3 的强大而优雅的组件系统，提供 Aria 层交互能力与开箱即用的样式封装。
        采用 Aria + UI 两层架构，复用底层交互能力，统一上层界面表达。
        
        
        
        
      
      
        
          
        
      
    
  


 简介

SoybeanAdmin 是一个清新优雅、高颜值且功能强大的后台管理模板，基于最新的前端技术栈，包括 Vue3, Vite8, TypeScript, Pinia 和 UnoCSS。它内置了丰富的主题配置和组件，代码规范严谨，实现了自动化的文件路由系统。此外，它还采用了基于 ApiFox 的在线Mock数据方案。SoybeanAdmin 为您提供了一站式的后台管理解决方案，无需额外配置，开箱即用。同样是一个快速学习前沿技术的最佳实践。

 特性

- 前沿技术应用：采用 Vue3, Vite8, TypeScript, Pinia 和 UnoCSS 等最新流行的技术栈。
- 清晰的项目架构：采用 pnpm monorepo 架构，结构清晰，优雅易懂。
- 严格的代码规范：遵循 SoybeanJS 规范，集成了eslint、oxlint、oxfmt 和 vp hooks，保证代码的规范性。
- TypeScript： 支持严格的类型检查，提高代码的可维护性。
- 丰富的主题配置：内置多样的主题配置，与 UnoCSS 完美结合。
- 内置国际化方案：轻松实现多语言支持。
- 自动化文件路由系统：自动生成路由导入、声明和类型。更多细节请查看 Elegant Router。
- 灵活的权限路由：同时支持前端静态路由和后端动态路由。
- 丰富的页面组件：内置多样页面和组件，包括403、404、500页面，以及布局组件、标签组件、主题配置组件等。
- 命令行工具：内置高效的命令行工具，git提交、删除文件、发布等。
- 移动端适配：完美支持移动端，实现自适应布局。

 版本

 [!IMPORTANT]
 3.0 版本正在开发中（Roadmap Issue 941）；2.3 是 2.x 系列最后一个维护的大版本。

- NaiveUI 版本:
  - 预览地址
  - Github 仓库
  - Gitee 仓库
  - Gitcode 仓库
- AntDesignVue 版本:
  - 预览地址
  - Github 仓库
  - Gitee 仓库
  - Gitcode 仓库
- ElementPlus 版本:
  - 预览地址
  - Github 仓库
  - Gitee 仓库
  - Gitcode 仓库
- 旧版:
  - 预览地址
  - Github 仓库
  - Gitee 仓库
  - Gitcode 仓库

 文档

- 地址
- 旧版文档

 合作事项

我们非常感谢大家对 SoybeanAdmin 的支持！为了进一步回馈社区，并助力企业和开发者实现个性化需求，我们现提供多种合作服务，期待与您携手共赢。

 1、定制化管理后台开发

针对企业和开发者的特定业务需求，我们提供基于 SoybeanAdmin 的定制化管理后台开发服务。我们的团队具备丰富的行业经验，能够迅速理解并实现您的需求，打造高效、灵活且安全的定制化解决方案。

- 定制开发：我们将根据您的具体需求，提供从需求分析、UI设计到功能实现的全方位服务，确保项目高效交付。
- 功能扩展：在 SoybeanAdmin 基础上，扩展您所需的特定功能模块，提升管理后台的功能和用户体验。

 2、企业外包服务

我们承接各类企业级外包项目，特别是在管理后台系统的开发、集成与运维方面。我们以精益求精的态度，确保项目的质量和进度，为您的业务提供强有力的技术支持。

- 项目开发：无论是全新的项目，还是现有系统的优化与集成，我们都将为您量身打造高效可靠的解决方案。
- 系统集成与维护：我们也提供基于 SoybeanAdmin 的系统集成与长期维护服务，确保您的系统稳定、安全地运行。

 3、联系方式

如有合作意向或项目咨询，请通过以下方式与我们联系：

- Email: [email protected]
- GitHub Issues: 欢迎通过 GitHub Issues 联系我们，进行初步的合作洽谈。
- 商务合作微信: honghuangdc

期待与您开展深入合作，共同推动 SoybeanAdmin 项目及其在更多领域的成功应用！

 示例图片

!
!
!
!
!
!
!
!
!
!
!

 使用

环境准备

确保你的环境满足以下要求：

- git: 你需要git来克隆和管理项目版本。
- NodeJS: =20.19.0，推荐 20.19.0 或更高。
- pnpm: = 10.5.0，推荐 10.5.0 或更高。

克隆项目

bash
 github
git clone https://github.com/soybeanjs/soybean-admin.git
 gitee
git clone https://gitee.com/honghuangdc/soybean-admin.git
 gitcode
git clone https://gitcode.com/soybeanjs/soybean-admin.git


安装依赖

bash
pnpm i


 由于本项目采用了 pnpm monorepo 的管理方式，因此请不要使用 npm 或 yarn 来安装依赖。

启动项目

bash
pnpm dev


构建项目

bas