﻿---
url: 'https://docs.soybeanjs.cn/zh/guide/intro.md'
---
# 介绍

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

## 特性

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

## 版本

* **NaiveUI 版本:**
  * [预览地址](https://naive.soybeanjs.cn/)
  * [Github 仓库](https://github.com/soybeanjs/soybean-admin)
  * [Gitee 仓库](https://gitee.com/honghuangdc/soybean-admin)

* **AntDesignVue 版本:**
  * [预览地址](https://antd.soybeanjs.cn/)
  * [Github 仓库](https://github.com/soybeanjs/soybean-admin-antd)
  * [Gitee 仓库](https://gitee.com/honghuangdc/soybean-admin-antd)

* **ElementPlus 版本:**
  * [预览地址](https://elp.soybeanjs.cn/)
  * [Github 仓库](https://github.com/soybeanjs/soybean-admin-element-plus)
  * [Gitee 仓库](https://gitee.com/honghuangdc/soybean-admin-element-plus)

* **旧版:**
  * [预览地址](https://legacy.soybeanjs.cn/)
  * [Github 仓库](https://github.com/soybeanjs/soybean-admin/tree/legacy)

## 分支

为方便用户使用，`main` 分支默认采用精简版，只保留核心框架内容，不包含业务性较高的示例，如果您需要更多的示例参考，可以切换到 `example` 分支，该分支即预览地址所呈现的内容，包含完整的示例菜单。

## 文档

* 文档地址为 [soybean-admin-docs](https://github.com/soybeanjs/soybean-admin-docs)，采用 Vitepress 开发。如发现文档有误，欢迎提 pr 帮助我们改进。

## 需要掌握的基础知识

本项目基于 Vue3, Vite, TS 开发，并全部采用了 Vue3 的**script-setup**写法，建议在开发前先学一下以下内容，提前了解和学习这些知识，会对项目理解非常有帮助:

* [ES6](https://es6.ruanyifeng.com/)
* [Vue3](https://vuejs.org/)
* [Vite](https://vitejs.dev/)
* [TypeScript](https://jkchao.github.io/typescript-book-chinese/#why)
* [Vue Router](https://router.vuejs.org/)
* [Pinia](https://pinia.vuejs.org/)
* [UnoCSS](https://uno.antfu.me/)
* [VueUse](https://vueuse.org/)
* [NaiveUI](https://www.naiveui.com/zh-CN/os-theme) / [AntDesign Vue](https://www.antdv.com/components/overview-cn/)

## 浏览器支持

本地开发推荐使用`Chrome 100+` 浏览器

支持现代浏览器, 不支持 IE

| IE | Edge | Firefox | Chrome | Safari |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|                                                                                                                not support                                                                                                                |                                                                                          last 2 versions                                                                                          |                                                                                               last 2 versions                                                                                                |                                                                                             last 2 versions                                                                                              |                                                                                             last 2 versions                                                                                              |

## 如何加入我们

* [SoybeanAdmin](https://github.com/honghuangdc/soybean-admin) 还在持续更新中，本项目欢迎您的参与，共同维护，逐步完善，将项目做得更强。项目采用 MIT 开源协议，本着一切免费的原则，原则上不会收取任何费用及版权，可以放心使用。
* 如果你想加入我们，可以多提供一些好的建议或者提交 pr，我们会根据你的活跃度邀请你加入。
