Home

Awesome

<p align="center"> <a href="https://tdesign.tencent.com/starter"><img src="https://tdesign.gtimg.com/starter/brand-logo.svg" /></a> </p> <p align="center"> <a href="https://www.npmjs.com/package/tdesign-starter-cli"> <img src="https://img.shields.io/npm/l/tdesign-starter-cli.svg?sanitize=true" alt="License" /> </a> <a href="https://www.npmjs.com/package/tdesign-starter-cli"> <img src="https://img.shields.io/npm/v/tdesign-starter-cli.svg?sanitize=true" alt="Version"> </a> <a href="https://www.npmjs.com/package/tdesign-starter-cli"> <img src="https://img.shields.io/node/v/tdesign-starter-cli" alt="Node"> </a> <a href="https://www.npmjs.com/package/tdesign-starter-cli"> <img src="https://img.shields.io/npm/dm/tdesign-starter-cli" alt="Downloads"> </a> </p>

English | 简体中文

Please note that the Node version installed on your local machine needs to be >=16.

Install

npm install tdesign-starter-cli -g

Usage

Interactive Operation


# project initialization
td-starter init

# fill project name and description
? 请输入项目名称: [project-name]
? 请输入项目描述: Base on tdesign-starter-cli
...

cd [project-name]

# install dependencies
npm install
      
# run dev
npm run dev 

Command Operation


# project initialization
td-starter init [root]

cd [project-name]

# install dependencies
npm install

# run dev     
npm run dev 

Command Options

OptionDescription
-d, --description <description>description of a project (default: "Base on tdesign-starter-cli")
-type, --type <type>Code version vue2 | vue3 | react | miniProgram | mobileVue (default: "vue2")
-temp, --template <template>Project template type: lite | all (default: "lite")
-bt, --buildToolType <buildToolType>The construction tool for lite: vite | webpack (default: "vite")
-h, --helpdisplay help for command

Preview

Vite + React/Vue2/Vue3

Farm + React/Vue2/Vue3

Webpack + React/Vue2/Vue3

License

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