image/tdesign-vue-next-starter
1
0
Fork 1
mirror of https://github.com/Tencent/tdesign-vue-next-starter.git synced 2024-11-10 11:18:25 +08:00
Code Issues Packages Projects Releases Wiki Activity
a7f2e59ca4
tdesign-vue-next-starter/ README-en_US.md
yuyang 7e40754fc1
docs: README in English (#301) 
* fix: miss layout header

* docs: readme in english

* fix: typo and grammar (#300)

* chore: add lang tab

Co-authored-by: Thet Paing Hein <paiakarit@gmail.com>
2022-09-13 16:42:51 +08:00

4.8 KiB
Raw Blame History

TDesign Logo

node compatility License

Introduction

TDesign Vue Next Starter is a TDesign-based developed with Vue3, Vite2, 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.

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

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

License

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