Home

Awesome

<p style="display:flex; justify-content: center"> </p> <p align="center"> <a href="https://tdesign.tencent.com/starter/react/#/dashboard/base" target="_blank"> <img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/starter/brand-logo.svg"> </a> </p> <p align="center"> <a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatibility"></a> <a href="https://github.com/Tencent/tdesign-react/blob/develop/LICENSE"> <img src="https://img.shields.io/npm/l/tdesign-react.svg?sanitize=true" alt="License"> </a> </p>

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.

<p> <a href="http://tdesign.tencent.com/starter/react/">Live Preview</a> · <a href="https://tdesign.tencent.com/starter/docs/react/get-started">Documentation</a> </p> <img src="docs/docs-starter.png">

Features

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

Compatibility

<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" /></br> IE / Edge<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" /></br>Firefox<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" /></br>Chrome<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" /></br>Safari
Edge >=84Firefox >=83Chrome >=84Safari >=14.1

License

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