-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
256 additions
and
255 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| <div align="center"> | ||
| <img src="./public/favicon.svg" width="160" /> | ||
| <h1>React SoybeanAdmin</h1> | ||
| <span><a href="./README.en-US.md">English</a> | 中文</span> | ||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| [](./LICENSE) | ||
|
|
||
| > [!NOTE] | ||
| > If you find `React SoybeanAdmin` helpful, or if you like our project, please give us a ⭐️ on GitHub. Your support motivates us to keep improving and adding new features! Thank you for your support! | ||
| ## Introduction | ||
|
|
||
| [`React Soybean`](https://github.com/mufeng889/react-soybean-admin) is a fresh, elegant, and powerful admin dashboard template. It is built on the latest frontend technology stack, including React18, ReactRouter V6, Vite5, TypeScript, Redux/toolkit, and UnoCSS. It comes with extensive theme configurations and components, adheres to strict coding standards, and features an automated file routing system. Additionally, it implements an online mock data solution based on ApiFox. `React Soybean` offers a one-stop admin dashboard solution with no extra setup, ready to use out-of-the-box. It's also a great best-practice tool for learning cutting-edge technologies. | ||
|
|
||
| ## Versions | ||
|
|
||
| ### React Version | ||
|
|
||
| - **React18 Version:** | ||
| - [Demo](https://github.com/mufeng889/react-soybean-admin/) | ||
| - [Faster Access (China)]( https://react-soybean-admin.pages.dev/) | ||
| - [GitHub Repository](https://github.com/mufeng889/react-soybean-admin) | ||
|
|
||
| #### Documentation | ||
|
|
||
| - [Link](https://react-soybean-docs.ohh-889.com/index-en?theme=dark) | ||
|
|
||
| ### Vue Version | ||
|
|
||
| - **NaiveUI Version:** | ||
| - [Demo](https://naive.soybeanjs.cn/) | ||
| - [GitHub Repository](https://github.com/soybeanjs/soybean-admin) | ||
| - [Gitee Repository](https://gitee.com/honghuangdc/soybean-admin) | ||
|
|
||
| - **AntDesignVue Version:** | ||
| - [Demo](https://antd.soybeanjs.cn/) | ||
| - [GitHub Repository](https://github.com/soybeanjs/soybean-admin-antd) | ||
| - [Gitee Repository](https://gitee.com/honghuangdc/soybean-admin-antd) | ||
|
|
||
| - **Legacy Version:** | ||
| - [Demo](https://legacy.soybeanjs.cn/) | ||
| - [GitHub Repository](https://github.com/soybeanjs/soybean-admin/tree/legacy) | ||
|
|
||
| #### Documentation | ||
|
|
||
| - [Link](https://docs.soybeanjs.cn) | ||
| - [Legacy Docs](https://legacy-docs.soybeanjs.cn) | ||
|
|
||
| ## Features | ||
|
|
||
| - **Cutting-edge Technologies**: Built with React18, ReactRouter V6, Vite5, TypeScript, Redux/toolkit, and UnoCSS. | ||
| - **Clear Project Structure**: Uses pnpm monorepo architecture with a clean, elegant structure. | ||
| - **Strict Code Standards**: Follows [SoybeanJS Standards](https://docs.soybeanjs.cn/zh/standard), integrated with eslint, prettier, and simple-git-hooks to ensure code quality. | ||
| - **TypeScript**: Supports strict type checking for better maintainability. | ||
| - **Extensive Theme Configuration**: Built-in diverse theme options seamlessly integrated with UnoCSS. | ||
| - **Built-in Internationalization**: Easily supports multiple languages. | ||
| - **Automated File Routing**: Automatically generates route imports, declarations, and types. See [Elegant Router](https://github.com/mufeng889/react-auto-route) for more details. | ||
| - **Flexible Permission-based Routing**: Supports both static frontend routing and dynamic backend routing. | ||
| - **Rich Page Components**: Includes a variety of pages and components, such as 403, 404, 500 error pages, layout components, tag components, theme settings, and more. | ||
| - **Command-line Tools**: Built-in efficient command-line tools for git commits, file deletion, publishing, etc. | ||
| - **Mobile-friendly**: Fully supports mobile devices with responsive layouts. | ||
|
|
||
| ## Sample Images | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Usage | ||
|
|
||
| **Environment Setup** | ||
|
|
||
| Make sure your environment meets the following requirements: | ||
|
|
||
| - **git**: Needed for cloning and version management. | ||
| - **NodeJS**: >=18.12.0, recommended 18.19.0 or higher. | ||
| - **pnpm**: >= 8.7.0, recommended 8.14.0 or higher. | ||
|
|
||
| **Clone the Project** | ||
|
|
||
| ```bash | ||
| git clone https://github.com/soybeanjs/soybean-admin.git | ||
| ``` | ||
|
|
||
| **Install Dependencies** | ||
|
|
||
| ```bash | ||
| pnpm i | ||
| ``` | ||
|
|
||
| > Since the project uses pnpm monorepo management, please do not use npm or yarn to install dependencies. | ||
| **Run the Project** | ||
|
|
||
| ```bash | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| **Build the Project** | ||
|
|
||
| ```bash | ||
| pnpm build | ||
| ``` | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| We warmly welcome and appreciate all forms of contribution. If you have any ideas or suggestions, feel free to share them by submitting [pull requests](https://github.com/mufeng889/react-soybean-admin/pulls) or creating GitHub [issues](https://github.com/mufeng889/react-soybean-admin/issues/new). | ||
|
|
||
| ## Git Commit Standards | ||
|
|
||
| This project includes a `commit` command. You can run `pnpm commit` to generate commit messages that comply with the [Conventional Commits](https://www.conventionalcommits.org/) standard. Please ensure to use the `commit` command when submitting PRs to maintain proper commit message format. | ||
|
|
||
| ## Browser Support | ||
|
|
||
| It is recommended to use the latest version of Chrome for development to get the best 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 | | ||
|
|
||
| ## Open-source Authors | ||
|
|
||
| [Ohh-889](https://github.com/mufeng889) | ||
|
|
||
| [Soybean](https://github.com/honghuangdc) | ||
|
|
||
| ## Contributors | ||
|
|
||
| We appreciate the contributions from the following contributors. If you would like to contribute, please refer to [How to Contribute](#how-to-contribute). | ||
|
|
||
| <a href="https://github.com/mufeng889/react-soybean-admin/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=mufeng889/react-soybean-admin" /> | ||
| </a> | ||
|
|
||
| ## Community | ||
|
|
||
| `React Soybean` is a completely open-source and free project, aimed at helping developers build medium | ||
|
|
||
| to large-scale management systems easily. We also provide WeChat and QQ groups for discussion. Feel free to ask questions in the groups. | ||
|
|
||
| <div> | ||
| <p>QQ Group</p> | ||
| <img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/qq-soybean-admin-3.jpg" style="width:200px" /> | ||
| </div> | ||
|
|
||
| <div> | ||
| <p>Scan below to join the WeChat group</p> | ||
| <img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/wechat-soybeanjs.jpg" style="width:200px" /> | ||
| </div> | ||
|
|
||
| <div> | ||
| <p>Scan below to join the WeChat group</p> | ||
| <img src="https://ohh-1321526050.cos.ap-nanjing.myqcloud.com/ohh-889.jpg" style="width:200px" /> | ||
| </div> | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [MIT © 2021 Soybean](./LICENSE) license. It is intended for learning and reference purposes only. For commercial use, please retain the author's copyright information. The author does not guarantee or assume any risks associated with the software's use. |
Oops, something went wrong.