image/tdesign-vue-next-starter
1
0
Fork 1
mirror of https://github.com/Tencent/tdesign-vue-next-starter.git synced 2024-12-23 09:29:50 +08:00
Code Issues Packages Projects Releases Wiki Activity
fa1746b2bb
tdesign-vue-next-starter/README.md
yuyang e7d715b9ad
chore: update docs
2023-02-10 12:13:31 +08:00

5.0 KiB
Raw Blame History

TDesign Logo

node compatility License

English | 简体中文

Introduction

TDesign Vue Next Starter is a TDesign-based developed with Vue 3, Vite 3+, Pinia, TypeScript. 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.

Commit Specification

Browser Support

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

Community Versions

There are kinds of community versions of starter-kit based on TDesign Vue Next, visit community-link for more detail. If you developed a community versions of tdesign starter, please create a issue or submit a pull request to let us know 😊.

License

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