-
Notifications
You must be signed in to change notification settings - Fork 42
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
2 changed files
with
6 additions
and
96 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 |
---|---|---|
@@ -1,55 +1,10 @@ | ||
<h1 align="center">React DevUI</h1> | ||
|
||
<p align="center">DevUI components based on React</p> | ||
<p align="center">UI components based on React</p> | ||
|
||
English | [简体中文](README.zh-CN.md) | ||
|
||
In development. | ||
- [react-devui.com](//react-devui.com) | ||
- [admin.react-devui.com](//admin.react-devui.com) | ||
|
||
Need unit test support (Jest) 🤝 | ||
|
||
## Start | ||
|
||
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. | ||
|
||
Execute the following command to preview the component: | ||
|
||
``` | ||
yarn site:serve | ||
``` | ||
|
||
For non-new component contributions, please refer to [Contribution Guide](CONTRIBUTING.md). | ||
|
||
## Directory Structure | ||
|
||
``` | ||
├── packages // Root Directory: Project | ||
│ │ | ||
│ │ | ||
│ ├── site // Root Directory: Website | ||
│ │ └── src | ||
│ │ ├── app | ||
│ │ │ ├── components // Components | ||
│ │ │ ├── configs // Configuration files (json) | ||
│ │ │ ├── i18n // Internationalization | ||
│ │ │ ├── routes // Routes | ||
│ │ │ └── styles // Styles | ||
│ │ ├── assets // Static resources | ||
│ │ └── environments // Configuration files in development and production environments | ||
│ │ | ||
│ │ | ||
│ └── ui // Root Directory: Components | ||
│ └── src | ||
│ ├── components // Components | ||
│ ├── hooks // Hooks | ||
│ ├── styles // Styles | ||
│ ├── tests // Test configuration | ||
│ └── utils // Utility function | ||
│ | ||
│ | ||
└── tools // Root Directory: Project Cli | ||
``` | ||
|
||
## VSCode configuration | ||
|
||
Refer to [README.md](https://github.com/DevCloudFE/react-devui/tree/main/.vscode) under the `.vscode` directory |
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 |
---|---|---|
@@ -1,55 +1,10 @@ | ||
<h1 align="center">React DevUI</h1> | ||
|
||
<p align="center">DevUI components based on React</p> | ||
<p align="center">基于 React 的 UI 组件库</p> | ||
|
||
[English](README.md) | 简体中文 | ||
|
||
开发中。 | ||
- [react-devui.com](//react-devui.com) | ||
- [admin.react-devui.com](//admin.react-devui.com) | ||
|
||
需要单元测试支持(Jest)🤝 | ||
|
||
## 开始 | ||
|
||
我们在 `prepare` 中添加 `chmod ug+x .husky/` 以确保文件在 linux 中是可执行的。 所以您使用其他操作系统,只需忽略错误。 | ||
|
||
执行下面的命令以预览组件: | ||
|
||
``` | ||
yarn site:serve | ||
``` | ||
|
||
非新组件贡献请参考 [贡献指南](CONTRIBUTING.md)。 | ||
|
||
## 目录结构 | ||
|
||
``` | ||
├── packages // 根目录:项目 | ||
│ │ | ||
│ │ | ||
│ ├── site // 根目录:网站 | ||
│ │ └── src | ||
│ │ ├── app | ||
│ │ │ ├── components // 组件 | ||
│ │ │ ├── configs // 配置文件(json) | ||
│ │ │ ├── i18n // 国际化 | ||
│ │ │ ├── routes // 路由 | ||
│ │ │ └── styles // 样式 | ||
│ │ ├── assets // 静态资源 | ||
│ │ └── environments // 开发和生产环境下的配置文件 | ||
│ │ | ||
│ │ | ||
│ └── ui // 根目录:组件 | ||
│ └── src | ||
│ ├── components // 组件 | ||
│ ├── hooks // Hooks | ||
│ ├── styles // 样式 | ||
│ ├── tests // 测试配置 | ||
│ └── utils // 实用函数 | ||
│ | ||
│ | ||
└── tools // 根目录:项目脚手架 | ||
``` | ||
|
||
## VSCode 配置 | ||
|
||
参考 `.vscode` 目录下的 [README.md](https://github.com/DevCloudFE/react-devui/tree/main/.vscode) |