Skip to content

Commit 97c8929

Browse files
piupuerpiupuer
committed
update README
1 parent 61d21a4 commit 97c8929

File tree

3 files changed

+26
-186
lines changed

3 files changed

+26
-186
lines changed

‎LICENSE‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
MIT License
22

3-
Copyright (c) 2021-present TDesign
3+
Copyright (c) 2023 Go Cinch
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
611

7-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
814

9-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README-zh_CN.md‎

Lines changed: 6 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,11 @@
1-
<p style="display:flex; justify-content: center">
1+
# Go Cinch React前端项目模板(基于TDesign)
22

3-
</p>
4-
<p align="center">
5-
<a href="https://tdesign.tencent.com/starter/react/#/dashboard/base" target="_blank">
6-
<img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/starter/brand-logo.svg">
7-
</a>
8-
</p>
3+
[English](./README.md) | 简体中文
94

10-
<p align="center">
11-
<a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatility"></a>
12-
<a href="https://github.com/Tencent/tdesign-react-starter/blob/develop/LICENSE">
13-
<img src="https://img.shields.io/npm/l/tdesign-react.svg?sanitize=true" alt="License">
14-
</a>
15-
</p>
5+
### 预览
166

17-
简体中文 | [English](./README.md)
7+
[在线演示](https://react.go-cinch.top/)
188

19-
### 项目简介
20-
21-
TDesign React Starter 是一个基于 tdesign-react，使用 `React`、`Vite2`开发，可进行个性化主题配置，旨在提供项目开箱即用的、配置式的中后台项目。
22-
23-
<img src="docs/docs-starter.png">
24-
25-
### 特性
26-
27-
- 内置多种常用的中后台页面
28-
- 完善的目录结构
29-
- 完善的代码规范配置
30-
- 支持暗黑模式
31-
- 自定义主题颜色
32-
- 多种空间布局
33-
- 内置 Mock 数据方案
34-
35-
### 开发
36-
37-
```bash
38-
## 安装依赖
39-
npm install
40-
41-
## 启动项目
42-
npm run dev
43-
44-
## mock方式启动项目
45-
npm run dev:mock
46-
```
47-
48-
### 构建
49-
50-
```bash
51-
## 构建正式环境
52-
npm run build
53-
54-
## 构建测试环境
55-
npm run build:test
56-
```
57-
58-
### 其他
59-
60-
```bash
61-
## 预览构建产物
62-
npm run preview
63-
64-
## 代码格式检查
65-
npm run lint
66-
67-
## 代码格式检查与自动修复
68-
npm run lint:fix
69-
70-
```
71-
72-
### 如何贡献
73-
74-
非常欢迎您的贡献！提交您的 [Issue](https://github.com/tencent/tdesign-react-starter/issues/new/choose) 或者提交 [Pull Request](https://github.com/Tencent/tdesign-react-starter/pulls)。
75-
76-
#### Pull Request
77-
78-
1. Fork 代码!
79-
2. 创建自己的分支: `git checkout -b feat/xxxx`
80-
3. 提交你的修改: `git commit -a 'feat(project): describe'`
81-
4. 推送您的分支: `git push origin feat/xxxx`
82-
5. 提交 `pull request`
83-
84-
#### 贡献提交规范
85-
86-
- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
87-
88-
### 兼容性
89-
90-
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br> IE / Edge | [<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/)</br>Firefox | [<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/)</br>Chrome | [<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/)</br>Safari |
91-
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
92-
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
93-
94-
### 开源协议
95-
96-
TDesign 遵循 [MIT 协议](https://github.com/Tencent/tdesign-react-starter/LICENSE)。
9+
### License
9710

11+
遵循 [MIT 协议](LICENSE)。

‎README.md‎

Lines changed: 4 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,10 @@
1-
<p style="display:flex; justify-content: center">
1+
# Go Cinch React starter(based on TDesign)
22

3-
</p>
4-
<p align="center">
5-
<a href="https://tdesign.tencent.com/starter/react/#/dashboard/base" target="_blank">
6-
<img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/starter/brand-logo.svg">
7-
</a>
8-
</p>
3+
English | [简体中文](./README-zh_CN.md)
94

10-
<p align="center">
11-
<a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatibility"></a>
12-
<a href="https://github.com/Tencent/tdesign-react/blob/develop/LICENSE">
13-
<img src="https://img.shields.io/npm/l/tdesign-react.svg?sanitize=true" alt="License">
14-
</a>
15-
</p>
5+
### Preview
166

17-
English | [简体中文](./README-zh_CN.md)
18-
### Introduction
19-
20-
TDesign React Starter is a TDesign-based project developed with `React`, `Vite`. It can be customized theme configuration, and aims to provide project out-of-the-box, configuration-style middle and background projects.
21-
22-
<p>
23-
<a href="http://tdesign.tencent.com/starter/react/">Live Preview</a>
24-
·
25-
<a href="https://tdesign.tencent.com/starter/docs/react/get-started">Documentation</a>
26-
</p>
27-
28-
<img src="docs/docs-starter.png">
29-
30-
### Features
31-
32-
- Various provided pages for develop
33-
- Complete directory structure for develop
34-
- Code specification configuration
35-
- Support dark mode
36-
- Custom theme colors
37-
- Various space layouts
38-
- Mock data scheme
39-
40-
### Usage
41-
42-
> Initialize project with our CLI tool `tdesign-starter-cli`
43-
44-
```bash
45-
## install tdesign-starter-cli
46-
npm i tdesign-starter-cli@latest -g
47-
48-
## create project
49-
td-starter init
50-
```
51-
52-
### Develop
53-
54-
```bash
55-
## install dependencies
56-
npm install
57-
58-
## set up
59-
npm run dev
60-
```
61-
62-
### Build
63-
64-
```bash
65-
## build
66-
npm run build
67-
68-
## build for test
69-
npm run build:test
70-
```
71-
72-
73-
### Contributing Guide
74-
75-
We welcome contributions to our project. Create your [Issue](https://github.com/tencent/tdesign-react-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-react-starter/pulls).
76-
77-
#### Pull Request
78-
79-
1. Fork it!
80-
2. Create your branch: `git checkout -b feat/xxxx`
81-
3. Commit: `git commit -a 'feat(project): describe'`
82-
4. Push: `git push origin feat/xxxx`
83-
5. New Pull Request `pull request`
84-
85-
#### Commit Specification
86-
87-
- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
88-
89-
### Compatibility
90-
91-
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br> IE / Edge | [<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/)</br>Firefox | [<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/)</br>Chrome | [<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/)</br>Safari |
92-
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93-
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
7+
[Online demo](https://react.go-cinch.top/)
948

959
### License
9610

0 commit comments

Comments
 (0)