Skip to content

Tencent/tdesign-starter-cli

Repository files navigation

License Version Node Downloads

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 [project name] [root]

cd [project-name]

# install dependencies
npm install

# run dev     
npm run dev 

Example

td-starter init tdesign-vue3-farm --type vue3 --buildToolType farm
td-starter init tdesign-vue3-farm -type vue3 -bt farm

Command Options

Option Description
-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, --help display 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.

About

CLI tool for TDesign Starter kit

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 11