chengfai / tdesign-react-starter

A starter-kit for TDesign React UI components

English | 简体中文

Introduction

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.

Live Preview · Documentation

Features

• Various provided pages for develop
• Complete directory structure for develop
• Code specification configuration
• Support dark mode
• Custom theme colors
• Various space layouts
• Mock data scheme

Usage

Initialize project with our CLI tool tdesign-starter-cli

## install tdesign-starter-cli
npm i tdesign-starter-cli@latest -g

## create project
td-starter init

Develop

## install dependencies
npm install

## set up
npm run dev

Build

## build
npm run build

## build for test
npm run build:test

Contributing Guide

We welcome contributions to our project. Create your Issue or Submit your Pull Request.

Pull Request

1. Fork it!
2. Create your branch: git checkout -b feat/xxxx
3. Commit: git commit -a 'feat(project): describe'
4. Push: git push origin feat/xxxx
5. New Pull Request pull request

Commit Specification

• Angular Convention

Compatibility

IE / Edge	Firefox	Chrome	Safari
Edge >=84	Firefox >=83	Chrome >=84	Safari >=14.1

License

The MIT License. Please see the license file for more information.