https://github.com/tencent/tdesign-react-starter

A starter-kit for TDesign React UI components
https://github.com/tencent/tdesign-react-starter

react starter-kit tdesign

Last synced: 14 days ago
JSON representation

A starter-kit for TDesign React UI components

Host: GitHub
URL: https://github.com/tencent/tdesign-react-starter
Owner: Tencent
License: mit
Created: 2022-02-22T16:19:22.000Z (over 3 years ago)
Default Branch: develop
Last Pushed: 2025-01-14T03:39:06.000Z (5 months ago)
Last Synced: 2025-05-12T16:16:50.767Z (18 days ago)
Topics: react, starter-kit, tdesign
Language: TypeScript
Homepage: https://tdesign.tencent.com/starter/react/
Size: 2.37 MB
Stars: 280
Watchers: 12
Forks: 92
Open Issues: 15
Metadata Files:
- Readme: README-zh_CN.md
- License: LICENSE

Awesome Lists containing this project

README

简体中文 | [English](./README.md)

### 项目简介

TDesign React Starter 是一个基于 tdesign-react，使用 `React`、`Vite2`开发，可进行个性化主题配置，旨在提供项目开箱即用的、配置式的中后台项目。

### 特性

- 内置多种常用的中后台页面
- 完善的目录结构
- 完善的代码规范配置
- 支持暗黑模式
- 自定义主题颜色
- 多种空间布局
- 内置 Mock 数据方案

### 开发

```bash
## 安装依赖
npm install

## 启动项目
npm run dev

## mock方式启动项目
npm run dev:mock
```

### 构建

```bash
## 构建正式环境
npm run build

## 构建测试环境
npm run build:test
```

### 其他

```bash
## 预览构建产物
npm run preview

## 代码格式检查
npm run lint

## 代码格式检查与自动修复
npm run lint:fix

```

### 如何贡献

非常欢迎您的贡献！提交您的 [Issue](https://github.com/tencent/tdesign-react-starter/issues/new/choose) 或者提交 [Pull Request](https://github.com/Tencent/tdesign-react-starter/pulls)。

#### Pull Request

1. Fork 代码!
2. 创建自己的分支: `git checkout -b feat/xxxx`
3. 提交你的修改: `git commit -a 'feat(project): describe'`
4. 推送您的分支: `git push origin feat/xxxx`
5. 提交 `pull request`

#### 贡献提交规范

- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)

### 兼容性

| [](http://godban.github.io/browsers-support-badges/) IE / Edge | [](http://godban.github.io/browsers-support-badges/)Firefox | [](http://godban.github.io/browsers-support-badges/)Chrome | [](http://godban.github.io/browsers-support-badges/)Safari |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |