6.2 KiB
Important
the old version of soybean-admin is moved to branch legacy. It is recommended to use the latest version of soybean-admin. the documents of new version is processing, please wait patiently.
Introduction
Soybean Admin is a fresh and elegant admin template based on Vue3, Vite5, TypeScript, Pinia and UnoCSS. It uses the latest popular front-end technology stack, built-in rich theme configuration, has a very high code specification, and is has an automatic, intelligent file routing system. It use ApiFox to generate mock data, out-of-the-box admin solutions, can also be used for learning reference.
Features
- Popular technology stack：Vue3, Vite5, TypeScript, Pinia, UnoCSS.
- Clean Structure：Use pnpm monorepo, clean and elegant structure, easy to maintain.
- TypeScript：Strictly typed, easy to maintain.
- Theme：Built-in rich theme configuration, easy to incorporate UnoCSS.
- File routing System：Automatic, intelligent file routing system. more details in Elegant Router.
- Auth Router: Support front-end static routing and back-end dynamic routing.
- Code Specification：Very high code specification. more details in SoybeanJS Code Standard.
Preview
Documentation
Repositories
| Repository | Github | Gitee | Preview |
|---|---|---|---|
| NaiveUI | github | gitee | preview |
| AntDesign Vue | github | gitee | preview |
Example Images
Usage
-
Environment Prepare
- NodeJS: >= 18.0.0 (recommend >=18.19.0)
recommend use fnm to manage nodejs version. Installation Tutorial
- pnpm: >= 8.0.0 (recommend >=8.14.0)
- git
-
Clone Project
git clone https://github.com/honghuangdc/soybean-admin.git
- Install Dependencies
pnpm i
The project uses pnpm monorepo, so you can't use npm or yarn to install dependencies.
- Start Project
pnpm dev
- Build Project
pnpm build
How to Contribute
We welcome all contributions. You can submit any ideas as pull requests or as a GitHub issue.
Git Commit Guidelines
The project has built-in command commit, so by executing pnpm commit you can create a commit message following Conventional Commits
Browser Support
It is recommended to use the latest version of Chrome in development for a better experience.
 |
 |
 |
 |
 |
|---|---|---|---|---|
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
OpenSource Author
Communication
-
QQ Group :
-
Soybean's Wechat (Business Consultancy or Cooperation) :
Donation
If you think this project is helpful to you, you can buy Soybean a drink to show your support, Soybean open source power can not be separated from your support and encouragement.
License
This project is based on the MIT © 2021 Soybean protocol, for learning purposes only, please retain the author's copyright information for commercial use, the author does not guarantee and is not responsible for the software.