132 lines
6.2 KiB
Markdown
132 lines
6.2 KiB
Markdown
<div align="center">
|
||
<img src="./public/favicon.svg" width="160" />
|
||
<h1>Soybean Admin</h1>
|
||
<span>English | <a href="./README.zh_CN.md">中文</a></span>
|
||
</div>
|
||
|
||
[](./LICENSE)  
|
||
|
||
>[!IMPORTANT]
|
||
> the old version of soybean-admin is moved to branch [legacy](https://github.com/honghuangdc/soybean-admin/tree/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](https://github.com/soybeanjs/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](https://github.com/soybeanjs/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
|
||
|
||
- [NaiveUI](https://admin.soybeanjs.cn)
|
||
- [AntDesign Vue](https://antd.soybeanjs.cn)
|
||
|
||
## Documentation
|
||
|
||
- [Docs](https://docs.soybeanjs.cn)
|
||
|
||
## Repositories
|
||
|
||
| Repository | Github | Gitee | Preview |
|
||
| --- | --- | --- | --- |
|
||
| NaiveUI | [github](https://github.com/honghuangdc/soybean-admin) | [gitee](https://gitee.com/honghuangdc/soybean-admin) | [preview](https://admin.soybeanjs.cn) |
|
||
| AntDesign Vue | [github](https://github.com/soybeanjs/soybean-admin-antd) | [gitee](https://gitee.com/honghuangdc/soybean-admin-antd) | [preview](https://antd.soybeanjs.cn) |
|
||
|
||
## Example Images
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## Usage
|
||
|
||
- Environment Prepare
|
||
|
||
- **NodeJS**: >= 18.0.0 (recommend >=18.19.0)
|
||
> recommend use [fnm](https://github.com/Schniz/fnm) to manage nodejs version. [Installation Tutorial](https://juejin.cn/post/7113462239734022158)
|
||
- **pnpm**: >= 8.0.0 (recommend >=8.14.0)
|
||
- **git**
|
||
|
||
- Clone Project
|
||
|
||
```bash
|
||
git clone https://github.com/honghuangdc/soybean-admin.git
|
||
```
|
||
|
||
- Install Dependencies
|
||
|
||
```bash
|
||
pnpm i
|
||
```
|
||
> The project uses pnpm monorepo, so you can't use npm or yarn to install dependencies.
|
||
|
||
- Start Project
|
||
|
||
```bash
|
||
pnpm dev
|
||
```
|
||
|
||
- Build Project
|
||
|
||
```bash
|
||
pnpm build
|
||
```
|
||
|
||
## How to Contribute
|
||
|
||
We welcome all contributions. You can submit any ideas as [pull requests](https://github.com/honghuangdc/soybean-admin/pulls) or as a GitHub [issue](https://github.com/honghuangdc/soybean-admin/issues/new).
|
||
|
||
## Git Commit Guidelines
|
||
|
||
The project has built-in command `commit`, so by executing `pnpm commit` you can create a commit message following [Conventional Commits](conventionalcommits)
|
||
|
||
## Browser Support
|
||
|
||
It is recommended to use the latest version of Chrome in development for a better experience.
|
||
|
||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png" alt="IE" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/) | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/) | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/) | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/) | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/) |
|
||
| --- | --- | --- | --- | --- |
|
||
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
||
|
||
## OpenSource Author
|
||
|
||
[Soybean](https://github.com/honghuangdc)
|
||
|
||
## Communication
|
||
|
||
- [GitHub Issue](https://github.com/honghuangdc/soybean-admin/issues)
|
||
<br />
|
||
|
||
- QQ Group :
|
||
|
||
<img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/qq.jpeg" style="width:200px" />
|
||
<br />
|
||
|
||
- Soybean's Wechat (Business Consultancy or Cooperation) :
|
||
|
||
<img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/wechat.jpeg" style="width:200px" />
|
||
|
||
## 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](./LICENSE) 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.
|