|
1 | 1 | <h1 align="center">React DevUI</h1>
|
2 | 2 |
|
3 |
| -<p align="center">DevUI components based on React</p> |
| 3 | +<p align="center">UI components based on React</p> |
4 | 4 |
|
5 | 5 | English | [简体中文](README.zh-CN.md)
|
6 | 6 |
|
7 |
| -In development. |
| 7 | +- [react-devui.com](//react-devui.com) |
| 8 | +- [admin.react-devui.com](//admin.react-devui.com) |
8 | 9 |
|
9 | 10 | Need unit test support (Jest) 🤝
|
10 |
| - |
11 |
| -## Start |
12 |
| - |
13 |
| -We add `chmod ug+x .husky/` at `prepare` that make sure the files is executable in linux. So you use other OS, just ignore error. |
14 |
| - |
15 |
| -Execute the following command to preview the component: |
16 |
| - |
17 |
| -``` |
18 |
| -yarn site:serve |
19 |
| -``` |
20 |
| - |
21 |
| -For non-new component contributions, please refer to [Contribution Guide](CONTRIBUTING.md). |
22 |
| - |
23 |
| -## Directory Structure |
24 |
| - |
25 |
| -``` |
26 |
| -├── packages // Root Directory: Project |
27 |
| -│ │ |
28 |
| -│ │ |
29 |
| -│ ├── site // Root Directory: Website |
30 |
| -│ │ └── src |
31 |
| -│ │ ├── app |
32 |
| -│ │ │ ├── components // Components |
33 |
| -│ │ │ ├── configs // Configuration files (json) |
34 |
| -│ │ │ ├── i18n // Internationalization |
35 |
| -│ │ │ ├── routes // Routes |
36 |
| -│ │ │ └── styles // Styles |
37 |
| -│ │ ├── assets // Static resources |
38 |
| -│ │ └── environments // Configuration files in development and production environments |
39 |
| -│ │ |
40 |
| -│ │ |
41 |
| -│ └── ui // Root Directory: Components |
42 |
| -│ └── src |
43 |
| -│ ├── components // Components |
44 |
| -│ ├── hooks // Hooks |
45 |
| -│ ├── styles // Styles |
46 |
| -│ ├── tests // Test configuration |
47 |
| -│ └── utils // Utility function |
48 |
| -│ |
49 |
| -│ |
50 |
| -└── tools // Root Directory: Project Cli |
51 |
| -``` |
52 |
| - |
53 |
| -## VSCode configuration |
54 |
| - |
55 |
| -Refer to [README.md](https://github.com/DevCloudFE/react-devui/tree/main/.vscode) under the `.vscode` directory |
0 commit comments