|
1 | 1 | <div align="center">
|
2 | 2 | <img src="./public/favicon.svg" width="160" />
|
3 | 3 | <h1>SoybeanAdmin</h1>
|
4 |
| - <span>中文 | <a href="./README.en_US.md">English</a></span> |
| 4 | + <span><a href="./README.md">中文</a> | English</span> |
5 | 5 | </div>
|
6 | 6 |
|
7 | 7 | ---
|
8 | 8 |
|
9 | 9 | [](./LICENSE)
|
10 |
| -[](https://github.com/soybeanjs/soybean-admin) |
11 |
| -[](https://github.com/soybeanjs/soybean-admin) |
| 10 | +[](https://github.com/soybeanjs/soybean-admin) |
| 11 | +[](https://github.com/soybeanjs/soybean-admin) |
12 | 12 | [](https://gitee.com/honghuangdc/soybean-admin)
|
13 | 13 |
|
14 | 14 | <a href="https://hellogithub.com/repository/1298f27d5fe54959a16cf9686516ddb3" target="_blank"><img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=1298f27d5fe54959a16cf9686516ddb3&claim_uid=IiDXWmP4TEntjbV" alt="Featured|HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
15 | 15 |
|
16 | 16 | > [!NOTE]
|
17 |
| -> 如果您觉得 `SoybeanAdmin`对您有所帮助,或者您喜欢我们的项目,请在 GitHub 上给我们一个 ⭐️。您的支持是我们持续改进和增加新功能的动力!感谢您的支持! |
| 17 | +> If you think `SoybeanAdmin` is helpful to you, or you like our project, please give us a ⭐️ on GitHub. Your support is the driving force for us to continue to improve and add new features! Thank you for your support! |
18 | 18 |
|
19 |
| -## 简介 |
| 19 | +## Introduction |
20 | 20 |
|
21 |
| -[`SoybeanAdmin`](https://github.com/soybeanjs/soybean-admin) 是一个清新优雅、高颜值且功能强大的后台管理模板,基于最新的前端技术栈,包括 Vue3, Vite5, TypeScript, Pinia 和 UnoCSS。它内置了丰富的主题配置和组件,代码规范严谨,实现了自动化的文件路由系统。此外,它还采用了基于 ApiFox 的在线Mock数据方案。`SoybeanAdmin` 为您提供了一站式的后台管理解决方案,无需额外配置,开箱即用。同样是一个快速学习前沿技术的最佳实践。 |
| 21 | +[`SoybeanAdmin`](https://github.com/soybeanjs/soybean-admin) is a clean, elegant, beautiful and powerful admin template, based on the latest front-end technology stack, including Vue3, Vite5, TypeScript, Pinia and UnoCSS. It has built-in rich theme configuration and components, strict code specifications, and an automated file routing system. In addition, it also uses the online mock data solution based on ApiFox. `SoybeanAdmin` provides you with a one-stop admin solution, no additional configuration, and out of the box. It is also a best practice for learning cutting-edge technologies quickly. |
22 | 22 |
|
23 |
| -## 特性 |
24 | 23 |
|
25 |
| -- **前沿技术应用**:采用 Vue3, Vite5, TypeScript, Pinia 和 UnoCSS 等最新流行的技术栈。 |
26 |
| -- **清晰的项目架构**:采用 pnpm monorepo 架构,结构清晰,优雅易懂。 |
27 |
| -- **严格的代码规范**:遵循 [SoybeanJS 规范](https://docs.soybeanjs.cn/zh/standard),集成了eslint, prettier 和 simple-git-hooks,保证代码的规范性。 |
28 |
| -- **TypeScript**: 支持严格的类型检查,提高代码的可维护性。 |
29 |
| -- **丰富的主题配置**:内置多样的主题配置,与 UnoCSS 完美结合。 |
30 |
| -- **内置国际化方案**:轻松实现多语言支持。 |
31 |
| -- **自动化文件路由系统**:自动生成路由导入、声明和类型。更多细节请查看 [Elegant Router](https://github.com/soybeanjs/elegant-router)。 |
32 |
| -- **灵活的权限路由**:同时支持前端静态路由和后端动态路由。 |
33 |
| -- **丰富的页面组件**:内置多样页面和组件,包括403、404、500页面,以及布局组件、标签组件、主题配置组件等。 |
34 |
| -- **命令行工具**:内置高效的命令行工具,git提交、删除文件、发布等。 |
35 |
| -- **移动端适配**:完美支持移动端,实现自适应布局。 |
| 24 | +## Features |
36 | 25 |
|
| 26 | +- **Cutting-edge technology application**: using the latest popular technology stack such as Vue3, Vite5, TypeScript, Pinia and UnoCSS. |
| 27 | +- **Clear project architecture**: using pnpm monorepo architecture, clear structure, elegant and easy to understand. |
| 28 | +- **Strict code specifications**: follow the [SoybeanJS specification](https://docs.soybeanjs.cn/standard), integrate eslint, prettier and simple-git-hooks to ensure the code is standardized. |
| 29 | +- **TypeScript**: support strict type checking to improve code maintainability. |
| 30 | +- **Rich theme configuration**: built-in a variety of theme configurations, perfectly integrated with UnoCSS. |
| 31 | +- **Built-in internationalization solution**: easily realize multi-language support. |
| 32 | +- **Automated file routing system**: automatically generate route import, declaration and type. For more details, please refer to [Elegant Router](https://github.com/soybeanjs/elegant-router). |
| 33 | +- **Flexible permission routing**: support both front-end static routing and back-end dynamic routing. |
| 34 | +- **Rich page components**: built-in a variety of pages and components, including 403, 404, 500 pages, as well as layout components, tag components, theme configuration components, etc. |
| 35 | +- **Command line tool**: built-in efficient command line tool, git commit, delete file, release, etc. |
| 36 | +- **Mobile adaptation**: perfectly support mobile terminal to realize adaptive layout. |
37 | 37 |
|
38 |
| -## 版本 |
39 | 38 |
|
40 |
| -- **NaiveUI 版本:** |
41 |
| - - [预览地址](https://naive.soybeanjs.cn/) |
42 |
| - - [Github 仓库](https://github.com/soybeanjs/soybean-admin) |
43 |
| - - [Gitee 仓库](https://gitee.com/honghuangdc/soybean-admin) |
| 39 | +## Version |
44 | 40 |
|
45 |
| -- **AntDesignVue 版本:** |
46 |
| - - [预览地址](https://antd.soybeanjs.cn/) |
47 |
| - - [Github 仓库](https://github.com/soybeanjs/soybean-admin-antd) |
48 |
| - - [Gitee 仓库](https://gitee.com/honghuangdc/soybean-admin-antd) |
| 41 | +- **NaiveUI Version:** |
| 42 | + - [Preview Link](https://naive.soybeanjs.cn/) |
| 43 | + - [Github Repository](https://github.com/soybeanjs/soybean-admin) |
| 44 | + - [Gitee Repository](https://gitee.com/honghuangdc/soybean-admin) |
49 | 45 |
|
50 |
| -- **旧版:** |
51 |
| - - [预览地址](https://legacy.soybeanjs.cn/) |
52 |
| - - [Github 仓库](https://github.com/soybeanjs/soybean-admin/tree/legacy) |
| 46 | +- **AntDesignVue Version:** |
| 47 | + - [Preview Link](https://antd.soybeanjs.cn/) |
| 48 | + - [Github Repository](https://github.com/soybeanjs/soybean-admin-antd) |
| 49 | + - [Gitee Repository](https://gitee.com/honghuangdc/soybean-admin-antd) |
53 | 50 |
|
| 51 | +- **Legacy Version:** |
| 52 | + - [Preview Link](https://legacy.soybeanjs.cn/) |
| 53 | + - [Github Repository](https://github.com/soybeanjs/soybean-admin/tree/legacy) |
54 | 54 |
|
55 |
| -## 文档 |
56 | 55 |
|
57 |
| -- [地址](https://docs.soybeanjs.cn) |
58 |
| -- [旧版文档](https://legacy-docs.soybeanjs.cn) |
| 56 | +## Documentation |
59 | 57 |
|
60 |
| -## 示例图片 |
| 58 | +- [Link](https://docs.soybeanjs.cn) |
| 59 | +- [Legacy Docs](https://legacy-docs.soybeanjs.cn) |
| 60 | + |
| 61 | +## Example Images |
61 | 62 |
|
62 | 63 | 
|
63 | 64 | 
|
|
72 | 73 | 
|
73 | 74 |
|
74 | 75 |
|
75 |
| -## 使用 |
| 76 | +## Usage |
76 | 77 |
|
77 |
| -**环境准备** |
| 78 | +**Environment Preparation** |
78 | 79 |
|
79 |
| -确保你的环境满足以下要求: |
| 80 | +Make sure your environment meets the following requirements: |
80 | 81 |
|
81 |
| -- **git**: 你需要git来克隆和管理项目版本。 |
82 |
| -- **NodeJS**: >=18.12.0,推荐 18.19.0 或更高。 |
83 |
| -- **pnpm**: >= 8.7.0,推荐 8.14.0 或更高。 |
| 82 | +- **git**: you need git to clone and manage project versions. |
| 83 | +- **NodeJS**: >=18.12.0, recommended 18.19.0 or higher. |
| 84 | +- **pnpm**: >= 8.7.0, recommended 8.14.0 or higher. |
84 | 85 |
|
85 |
| -**克隆项目** |
| 86 | +**Clone Project** |
86 | 87 |
|
87 | 88 | ```bash
|
88 | 89 | git clone https://github.com/soybeanjs/soybean-admin.git
|
89 | 90 | ```
|
90 | 91 |
|
91 |
| -**安装依赖** |
| 92 | +**Install Dependencies** |
92 | 93 |
|
93 | 94 | ```bash
|
94 | 95 | pnpm i
|
95 | 96 | ```
|
96 |
| -> 由于本项目采用了 pnpm monorepo 的管理方式,因此请不要使用 npm 或 yarn 来安装依赖。 |
| 97 | +> Since this project uses the pnpm monorepo management method, please do not use npm or yarn to install dependencies. |
97 | 98 |
|
98 |
| -**启动项目** |
| 99 | +**Start Project** |
99 | 100 |
|
100 | 101 | ```bash
|
101 | 102 | pnpm dev
|
102 | 103 | ```
|
103 | 104 |
|
104 |
| -**构建项目** |
| 105 | +**Build Project** |
105 | 106 |
|
106 | 107 | ```bash
|
107 | 108 | pnpm build
|
108 | 109 | ```
|
109 | 110 |
|
110 |
| -## 周边生态 |
111 |
| - |
112 |
| -- [electron-mock-admin](https://github.com/lixin59/electron-mock-api): 一个 Mock Api 管理系统,帮助前端开发伙伴快速实现接口的 mock。 |
113 |
| -- [T-Shell](https://github.com/TheBlindM/T-Shell): 是一个可配置命令提示的终端模拟器和 SSH 客户端。 |
114 |
| -- [pea](https://github.com/haitang1894/pea) : 采用SpringBoot3.2 + JDK21、MyBatis-Plus、SpringSecurity安全框架等,适配 [soybean-admin](https://gitee.com/honghuangdc/soybean-admin) 开发的简单权限系统。 |
115 |
| -- [MalusAdmin](https://github.com/pridejoy/MalusAdmin): 基于 Vue3/TypeScript/NaiveUI 和 NET7 & Sqlsugar 开发的后台管理框架。采用最原生最简洁的方式来实现, 前端清新优雅高颜值,后端 结构清晰,优雅易懂,功能强大。 |
116 |
| -- [PanisAdmin](https://github.com/paynezhuang/panis-admin): 采用SpringBoot3、SaToken、MySQL等框架开发,二次修改 [soybean-admin](https://github.com/soybeanjs/soybean-admin),适配动态菜单/按钮级别的鉴权,保留原汁原味、清新优雅、高颜值的后台管理系统脚手架。 |
117 |
| -- [snail-job](https://github.com/aizuda/snail-job): 一款兼具 “高性能、高颜值、高活跃” 的分布式任务重试和分布式任务调度平台。 |
118 |
| -- [SuperApi](https://github.com/TmmTop/SuperApi): 快速将你的 idea 变成线上稳定运行的产品! 无实体建库建表,对无实体库表进行增删改查,支持 15 种条件查询,以及分页,列表,无限级树形列表 等功能的 API 部署! 拥有接口文档,Auth 授权,接口限流,获取客户端真实 IP,先进的服务器缓存组件,动态 API 等功能,期待您的体验! |
119 |
| -- [FastSoyAdmin](https://github.com/sleep1223/fast-soy-admin): 基于 FastAPI+Vue3+Naive UI 的现代化轻量管理平台. |
| 111 | +## Ecosystem |
120 | 112 |
|
| 113 | +- [electron-mock-admin](https://github.com/lixin59/electron-mock-api): A Mock Api management system that helps front-end developers quickly implement interface mocks. |
| 114 | +- [T-Shell](https://github.com/TheBlindM/T-Shell): A terminal emulator and SSH client with configurable command prompts. |
| 115 | +- [pea](https://github.com/haitang1894/pea) : Adopting SpringBoot3.2 + JDK21, MyBatis-Plus, SpringSecurity security framework, etc., suitable for the simple permission system developed by [soybean-admin](https://gitee.com/honghuangdc/soybean-admin). |
| 116 | +- [MalusAdmin](https://github.com/pridejoy/MalusAdmin): A backend management framework developed based on Vue3/TypeScript/NaiveUI and NET7 & Sqlsugar. It is implemented in the most original and simplest way, with a fresh and elegant front-end, a clear and elegant backend structure, and powerful functions. |
| 117 | +- [PanisAdmin](https://github.com/paynezhuang/panis-admin): Adopting SpringBoot 3, SaToken, MySQL and other frameworks to develop and modify [soybean-admin](https://github.com/soybeanjs/soybean-admin) for the second time, adapting dynamic menu/button-level authorization. Retaining the original flavor, fresh and elegant, high-value back-end management system scaffold. |
| 118 | +- [snail-job](https://github.com/aizuda/snail-job): A distributed task retry and task scheduling platform with "high performance, high value and high activity". |
| 119 | +- [SuperApi](https://github.com/TmmTop/SuperApi): Quickly turn your idea into an online stable product! Entity-less library and table building, add, delete, change and check entity-less library table, support 15 kinds of condition query, as well as paging, list, unlimited tree list and other functions of the API deployment! With interface documentation, Auth authorisation, interface flow restriction, access to the client's real IP, advanced server caching components, dynamic APIs and other features, we look forward to your experience! |
| 120 | +- [FastSoyAdmin](https://github.com/sleep1223/fast-soy-admin): A modern Management Platform based on FastAPI+Vue3+Naive UI. |
121 | 121 |
|
122 |
| -## 如何贡献 |
123 | 122 |
|
124 |
| -我们热烈欢迎并感谢所有形式的贡献。如果您有任何想法或建议,欢迎通过提交 [pull requests](https://github.com/soybeanjs/soybean-admin/pulls) 或创建 GitHub [issue](https://github.com/soybeanjs/soybean-admin/issues/new) 来分享。 |
| 123 | +## How to Contribute |
125 | 124 |
|
126 |
| -## Git 提交规范 |
| 125 | +We warmly welcome and appreciate all forms of contributions. If you have any ideas or suggestions, please feel free to share them by submitting [pull requests](https://github.com/soybeanjs/soybean-admin/pulls) or creating GitHub [issue](https://github.com/soybeanjs/soybean-admin/issues/new). |
127 | 126 |
|
128 |
| -本项目已内置 `commit` 命令,您可以通过执行 `pnpm commit` 来生成符合 [Conventional Commits]([conventionalcommits](https://www.conventionalcommits.org/)) 规范的提交信息。在提交PR时,请务必使用 `commit` 命令来创建提交信息,以确保信息的规范性。 |
| 127 | +## Git Commit Guidelines |
129 | 128 |
|
| 129 | +This project has built-in `commit` command, you can execute `pnpm commit` to generate commit information that conforms to [Conventional Commits](https://www.conventionalcommits.org/) specification. When submitting PR, please be sure to use `commit` command to create commit information to ensure the standardization of information. |
130 | 130 |
|
131 |
| -## 浏览器支持 |
| 131 | +## Browser Support |
132 | 132 |
|
133 |
| -推荐使用最新版的 Chrome 浏览器进行开发,以获得更好的体验。 |
| 133 | +It is recommended to use the latest version of Chrome in development for a better experience. |
134 | 134 |
|
135 | 135 | | [<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/) |
|
136 | 136 | | --- | --- | --- | --- | --- |
|
137 | 137 | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
138 | 138 |
|
139 |
| -## 开源作者 |
| 139 | +## OpenSource Author |
140 | 140 |
|
141 | 141 | [Soybean](https://github.com/honghuangdc)
|
142 | 142 |
|
| 143 | +## Contributors |
143 | 144 |
|
144 |
| -## 贡献者 |
145 |
| - |
146 |
| -感谢以下贡献者的贡献。如果您想为本项目做出贡献,请参考 [如何贡献](#如何贡献)。 |
| 145 | +Thanks the following people for their contributions. If you want to contribute to this project, please refer to [How to Contribute](#how-to-contribute). |
147 | 146 |
|
148 | 147 | <a href="https://github.com/soybeanjs/soybean-admin/graphs/contributors">
|
149 | 148 | <img src="https://contrib.rocks/image?repo=soybeanjs/soybean-admin" />
|
150 | 149 | </a>
|
151 | 150 |
|
152 |
| -## 交流 |
| 151 | +## Communication |
153 | 152 |
|
154 |
| -`SoybeanAdmin` 是完全开源免费的项目,在帮助开发者更方便地进行中大型管理系统开发,同时也提供微信和 QQ 交流群,使用问题欢迎在群内提问。 |
| 153 | +`SoybeanAdmin` is a completely open source and free project, helping developers to develop medium and large-scale management systems more conveniently. It also provides WeChat and QQ communication groups. If you have any questions, please feel free to ask in the group. |
155 | 154 |
|
156 | 155 | <div>
|
157 |
| - <p>QQ交流群</p> |
| 156 | + <p>QQ Group</p> |
158 | 157 | <img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/qq-soybean-admin-3.jpg" style="width:200px" />
|
159 | 158 | </div>
|
160 | 159 | <!-- <div>
|
161 |
| - <p>微信群</p> |
| 160 | + <p>WeChat Group</p> |
162 | 161 | <img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/picgo/soybean-admin-wechat-0620.jpg" style="width:200px" />
|
163 | 162 | </div> -->
|
164 | 163 | <div>
|
165 |
| - <p>添加下面微信邀请进微信群</p> |
| 164 | + <p>Add the following WeChat to invite to the WeChat group</p> |
166 | 165 | <img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/wechat-soybeanjs.jpg" style="width:200px" />
|
167 | 166 | </div>
|
168 | 167 | <div>
|
169 |
| - <p>添加 Soybean 的微信,业务咨询、合作、项目架构、一对一指导等</p> |
| 168 | + <p>Add Soybean's WeChat for business consultation, cooperation, project architecture, one-on-one guidance, etc.</p> |
170 | 169 | <img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/wechat-soybean.jpg" style="width:200px" />
|
171 | 170 | </div>
|
172 | 171 |
|
173 |
| -## Star 趋势 |
| 172 | +## Star Trend |
174 | 173 |
|
175 | 174 | [](https://star-history.com/#soybeanjs/soybean-admin&Date)
|
176 | 175 |
|
177 |
| -## 开源协议 |
| 176 | +## License |
178 | 177 |
|
179 |
| -项目基于 [MIT © 2021 Soybean](./LICENSE) 协议,仅供学习参考,商业使用请保留作者版权信息,作者不保证也不承担任何软件的使用风险。 |
| 178 | +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. |
0 commit comments