soybean-admin README

The project's README from github.com/soybeanjs/soybean-admin. As one markdown file: README.md.

SoybeanAdmin

中文 | English

license github stars github forks gitee stars gitcode star

soybeanjs%2Fsoybean-admin | Trendshift Featured|HelloGitHub

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

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

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

Vue 3 Headless Admin
Visit SoybeanUI

简介

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

特性

版本

文档

合作事项

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

1、定制化管理后台开发

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

2、企业外包服务

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

3、联系方式

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

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

示例图片

使用

环境准备

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

克隆项目

# 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

安装依赖

pnpm i

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

启动项目

pnpm dev

构建项目

pnpm build

代码同步

参考 代码同步 文档。

周边生态

更多周边生态请翻阅 周边生态 文档。

如何贡献

我们热烈欢迎并感谢所有形式的贡献。如果您有任何想法或建议,欢迎通过提交 pull requests 或创建 GitHub issue 来分享。

Git 提交规范

本项目已内置 commit 命令,您可以通过执行 pnpm commit 来生成符合 Conventional Commits 规范的提交信息。在提交PR时,请务必使用 commit 命令来创建提交信息,以确保信息的规范性。

浏览器支持

推荐使用最新版的 Chrome 浏览器进行开发,以获得更好的体验。

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

开源作者

Soybean

贡献者

感谢以下贡献者的贡献。如果您想为本项目做出贡献,请参考 如何贡献。


以下是近一年中活跃度较高的贡献者,感谢各位的支持,让项目得以持续发展。

Contribution Leaderboard

交流

SoybeanAdmin 是完全开源免费的项目,在帮助开发者更方便地进行中大型管理系统开发,同时提供飞书群供大家交流,使用问题欢迎在群内提问。

飞书群

Star 趋势

Star History Chart

开源协议

项目基于 MIT © 2021 Soybean 协议,仅供学习参考,商业使用请保留作者版权信息,作者不保证也不承担任何软件的使用风险。

soybean-admin (soybeanjs/soybean-admin)

router
Searching Database…

What is this?SoybeanAdmin is a clean, elegant and feature-rich admin template for Vue3 — a ready-made dashboard boilerplate built on Vite, TypeScript, Pinia, NaiveUI and UnoCSS that works out of the box.
So is it a finished app I deploy, or a codebase I build my own project on?It is a template codebase, not a hosted app: you clone the pnpm monorepo and customize it into your own management system. It also doubles as a best-practice reference for learning the modern Vue stack.
How do I get it running locally?Clone the repo, run pnpm install, then pnpm dev to start the Vite dev server; pnpm build produces a production build.
What do I need installed before that?Git, Node.js >= 20.19.0 and pnpm >= 10.5.0 — and pnpm specifically: npm and yarn are explicitly off-limits because the project is managed as a pnpm monorepo.
Does it work in older browsers?No legacy support: IE is not supported, the target is the last two versions of modern browsers, and the README recommends developing in the latest Chrome.
What does it include out of the box?Rich theme configuration integrated with UnoCSS, built-in i18n, an automated file-based routing system (Elegant Router), permission routing with both static front-end and dynamic back-end routes, ready-made 403/404/500 pages, layout and tab components, mobile-adaptive layout, and a built-in CLI for git commits and releases.
Is there a version for a UI library other than NaiveUI?Yes — besides the main NaiveUI version there are AntDesignVue and ElementPlus variants, each with live previews and repos, plus a legacy older version. The community also maintains skyroc-admin, a React implementation.
How does mock data work during development?The template ships with an online mock solution based on ApiFox, so API stubs need no extra setup. The ecosystem also offers electron-mock-admin, a mock API manager for front-end developers.
Is there a ready back-end I can pair it with?Yes — several community back-ends are adapted to it: pea (Spring Boot 3.2 + JDK 21), MalusAdmin (.NET 7), PanisAdmin (Spring Boot 3), soybean-admin-go (Gin + GORM) and FastSoyAdmin (FastAPI + Vue3), with dynamic routes and interface auth wired up.
Creator
soybeanjs
Size
20.5 MB
Stars
15.1K
Age
5y
Commits · 90 Days