README-SoyBean.md

Soybean Admin

注意

Soybean Admin 正在重构，重构后的版本为v1.0，变更点如下:

• 采用基于 pnpm 的 monorepo 管理项目
• 第三方 soybeanjs 的工具库直接抽离到项目中(ElegantRouter除外)，不再作为依赖
• 采用全新的路由插件 ElegantRouter
• 使用基于 ApiFox 的远程 mock 代替本地 mock
• 基于现有路由插件迁移至新路由插件的指南
• 代码实现遵循 SoybeanJS 的代码规范
• 项目的 main 分支保留系统核心部分，示例页面和无关核心的插件移至 example 分支
• 完整 1.0 版本的文档

1.0版本仍然采用 NaiveUI

同时推出需要商业授权的 AntDesignVue 版本 和 ElementPlus 版本

全新收费版的 Elegant Admin 会同时进行开发，特性如下:

• 与UI框架无关的核心架子，基础组件由基于UnoCSS实现的组件提供，可以对接不同的UI框架
• 更丰富的主题配置及系统主题定制私有化

简介

Soybean Admin 是一个基于 Vue3、Vite3、TypeScript、NaiveUI、Pinia 和 UnoCSS 的清新优雅的中后台模版，它使用了最新流行的前端技术栈，内置丰富的主题配置，有着极高的代码规范，基于文件的路由系统以及基于 Mock 的动态权限路由，开箱即用的中后台前端解决方案，也可用于学习参考。

特性

• 最新流行技术栈：使用 Vue3/Vite 等前端前沿技术开发, 使用高效率的 npm 包管理器 pnpm
• TypeScript: 应用程序级 JavaScript 的语言
• 主题：丰富可配置的主题、暗黑模式，基于原子 css 框架 - UnoCss 的动态主题颜色
• 代码规范：丰富的规范插件及极高的代码规范
• 文件路由系统：基于文件的路由系统，根据页面文件自动生成路由声明、路由导入和路由模块
• 权限路由：提供前端静态和后端动态两种路由模式，基于 mock 的动态路由能快速实现后端动态路由
• 请求函数：基于 axios 的完善的请求函数封装，提供 Promise 和 hooks 两种请求函数，加入请求结果数据转换的适配器

SoybeanJS 工具库

• @soybeanjs/cli: SoybeanJS 命令行工具，包含发布、git 和依赖等相关的实用命令
• @soybeanjs/changelog: 根据 git tags 和 commits 生成 changelog 示例
• eslint-config-soybeanjs: SoybeanJS 的 eslint 预设配置
• @soybeanjs/materials: SoybeanJS 的物料仓库
• @soybeanjs/vite-plugin-vue-page-route: SoybeanAdmin 的路由插件

基于 SoybeanAdmin 二次开发的项目

• electron-mock-admin: 一个 Mock Api 管理系统，帮助前端开发伙伴快速实现接口的 mock。
• T-Shell: 是一个可配置命令提示的终端模拟器和 SSH 客户端。

在线预览

• Soybean Admin 预览地址

文档

• 项目文档预览地址

代码仓库

仓库	GitHub 地址	gitee 镜像	预览
soybean-admin	GitHub	gitee	预览
tauri 版	tauri 版	tauri 版
精简版	精简版	精简版
集成 fast-crud	集成 fast-crud	集成 fast-crud	预览

更新日志

CHANGELOG

后端服务

• soybean-admin-java

项目示例图

 

安装使用

• 环境配置 本地环境需要安装 pnpm 7.x 、Node.js 14.18+ 和 Git

• 克隆代码

git clone https://github.com/honghuangdc/soybean-admin.git

• 安装依赖

pnpm i

• 运行

pnpm dev

• 打包

pnpm build

Docker 部署

• Docker 部署 Soybean

docker build -t soybean-admin-image -f docker/Dockerfile .
docker run -d -p 80:80 soybean-admin-image

• 访问 SoybeanAdmin

打开本地浏览器访问http://localhost

如何贡献

非常欢迎您的加入！提一个 Issue 或者提交一个 Pull Request。

Git 贡献提交规范

项目已经内置 Angular 提交规范，直接执行 commit 命令即可生成符合 Angular 提交规范的 commit。

项目已用 simple-git-hooks 代替了 husky, 旧版本用了 husky，执行 pnpm soy init-simple-git-hooks 进行初始化配置

浏览器支持

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

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

IE	Edge	Firefox	Chrome	Safari
not support	last 2 versions	last 2 versions	last 2 versions	last 2 versions

开源作者

@Soybean

交流

Soybean Admin 是完全开源免费的项目，在帮助开发者更方便地进行中大型管理系统开发，同时也提供微信和 QQ 交流群，使用问题欢迎在群内提问。

QQ交流群

添加本人微信，欢迎来技术交流，业务咨询

捐赠

如果你觉得这个项目对你有帮助，可以请 Soybean 喝杯饮料表示支持，Soybean 开源的动力离不开各位的支持和鼓励。

License

本项目基于MIT © Soybean-2021 协议，仅供参考学习，商用时请保留作者的版权信息，作者不对软件做担保和负责。