Skip to content

Commit e9ebeb2

Browse files
committed
chore(README): update README
1 parent bc67301 commit e9ebeb2

File tree

3 files changed

+256
-255
lines changed

3 files changed

+256
-255
lines changed

README.en-US.md

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
<div align="center">
2+
<img src="./public/favicon.svg" width="160" />
3+
<h1>React SoybeanAdmin</h1>
4+
<span><a href="./README.en-US.md">English</a> | 中文</span>
5+
</div>
6+
7+
---
8+
9+
[![license](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
10+
11+
> [!NOTE]
12+
> 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!
13+
14+
## Introduction
15+
16+
[`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.
17+
18+
## Versions
19+
20+
### React Version
21+
22+
- **React18 Version:**
23+
- [Demo](https://github.com/mufeng889/react-soybean-admin/)
24+
- [Faster Access (China)]( https://react-soybean-admin.pages.dev/)
25+
- [GitHub Repository](https://github.com/mufeng889/react-soybean-admin)
26+
27+
#### Documentation
28+
29+
- [Link](https://react-soybean-docs.ohh-889.com/index-en?theme=dark)
30+
31+
### Vue Version
32+
33+
- **NaiveUI Version:**
34+
- [Demo](https://naive.soybeanjs.cn/)
35+
- [GitHub Repository](https://github.com/soybeanjs/soybean-admin)
36+
- [Gitee Repository](https://gitee.com/honghuangdc/soybean-admin)
37+
38+
- **AntDesignVue Version:**
39+
- [Demo](https://antd.soybeanjs.cn/)
40+
- [GitHub Repository](https://github.com/soybeanjs/soybean-admin-antd)
41+
- [Gitee Repository](https://gitee.com/honghuangdc/soybean-admin-antd)
42+
43+
- **Legacy Version:**
44+
- [Demo](https://legacy.soybeanjs.cn/)
45+
- [GitHub Repository](https://github.com/soybeanjs/soybean-admin/tree/legacy)
46+
47+
#### Documentation
48+
49+
- [Link](https://docs.soybeanjs.cn)
50+
- [Legacy Docs](https://legacy-docs.soybeanjs.cn)
51+
52+
## Features
53+
54+
- **Cutting-edge Technologies**: Built with React18, ReactRouter V6, Vite5, TypeScript, Redux/toolkit, and UnoCSS.
55+
- **Clear Project Structure**: Uses pnpm monorepo architecture with a clean, elegant structure.
56+
- **Strict Code Standards**: Follows [SoybeanJS Standards](https://docs.soybeanjs.cn/zh/standard), integrated with eslint, prettier, and simple-git-hooks to ensure code quality.
57+
- **TypeScript**: Supports strict type checking for better maintainability.
58+
- **Extensive Theme Configuration**: Built-in diverse theme options seamlessly integrated with UnoCSS.
59+
- **Built-in Internationalization**: Easily supports multiple languages.
60+
- **Automated File Routing**: Automatically generates route imports, declarations, and types. See [Elegant Router](https://github.com/mufeng889/react-auto-route) for more details.
61+
- **Flexible Permission-based Routing**: Supports both static frontend routing and dynamic backend routing.
62+
- **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.
63+
- **Command-line Tools**: Built-in efficient command-line tools for git commits, file deletion, publishing, etc.
64+
- **Mobile-friendly**: Fully supports mobile devices with responsive layouts.
65+
66+
## Sample Images
67+
68+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-01.png)
69+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-02.png)
70+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-03.png)
71+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-04.png)
72+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-05.png)
73+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-06.png)
74+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-07.png)
75+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-08.png)
76+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-09.png)
77+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-10.png)
78+
![](https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/soybean-admin-v1-mobile.png)
79+
80+
## Usage
81+
82+
**Environment Setup**
83+
84+
Make sure your environment meets the following requirements:
85+
86+
- **git**: Needed for cloning and version management.
87+
- **NodeJS**: >=18.12.0, recommended 18.19.0 or higher.
88+
- **pnpm**: >= 8.7.0, recommended 8.14.0 or higher.
89+
90+
**Clone the Project**
91+
92+
```bash
93+
git clone https://github.com/soybeanjs/soybean-admin.git
94+
```
95+
96+
**Install Dependencies**
97+
98+
```bash
99+
pnpm i
100+
```
101+
102+
> Since the project uses pnpm monorepo management, please do not use npm or yarn to install dependencies.
103+
104+
**Run the Project**
105+
106+
```bash
107+
pnpm dev
108+
```
109+
110+
**Build the Project**
111+
112+
```bash
113+
pnpm build
114+
```
115+
116+
## How to Contribute
117+
118+
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).
119+
120+
## Git Commit Standards
121+
122+
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.
123+
124+
## Browser Support
125+
126+
It is recommended to use the latest version of Chrome for development to get the best experience.
127+
128+
| [<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/) |
129+
| --- | --- | --- | --- | --- |
130+
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
131+
132+
## Open-source Authors
133+
134+
[Ohh-889](https://github.com/mufeng889)
135+
136+
[Soybean](https://github.com/honghuangdc)
137+
138+
## Contributors
139+
140+
We appreciate the contributions from the following contributors. If you would like to contribute, please refer to [How to Contribute](#how-to-contribute).
141+
142+
<a href="https://github.com/mufeng889/react-soybean-admin/graphs/contributors">
143+
<img src="https://contrib.rocks/image?repo=mufeng889/react-soybean-admin" />
144+
</a>
145+
146+
## Community
147+
148+
`React Soybean` is a completely open-source and free project, aimed at helping developers build medium
149+
150+
to large-scale management systems easily. We also provide WeChat and QQ groups for discussion. Feel free to ask questions in the groups.
151+
152+
<div>
153+
<p>QQ Group</p>
154+
<img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/qq-soybean-admin-3.jpg" style="width:200px" />
155+
</div>
156+
157+
<div>
158+
<p>Scan below to join the WeChat group</p>
159+
<img src="https://soybeanjs-1300612522.cos.ap-guangzhou.myqcloud.com/uPic/wechat-soybeanjs.jpg" style="width:200px" />
160+
</div>
161+
162+
<div>
163+
<p>Scan below to join the WeChat group</p>
164+
<img src="https://ohh-1321526050.cos.ap-nanjing.myqcloud.com/ohh-889.jpg" style="width:200px" />
165+
</div>
166+
167+
## License
168+
169+
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.

0 commit comments

Comments
 (0)