tdesign-vue-next-starter/README.md

99 lines
4.9 KiB
Markdown
Raw Normal View History

2021-12-15 21:09:28 +08:00
<p style="display:flex; justify-content: center">
2021-12-14 23:23:52 +08:00
2021-12-15 21:09:28 +08:00
</p>
<p align="center">
2021-12-16 12:06:40 +08:00
<a href="https://tdesign.tencent.com/starter/vue-next/#/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 compatility"></a>
2021-12-16 12:06:40 +08:00
<a href="https://github.com/Tencent/tdesign-vue-next/blob/develop/LICENSE">
<img src="https://img.shields.io/npm/l/tdesign-vue-next.svg?sanitize=true" alt="License">
</a>
</p>
English | [简体中文](./README-zh_CN.md)
### Introduction
2021-12-16 12:06:40 +08:00
2022-09-13 16:55:41 +08:00
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.
2021-12-16 12:06:40 +08:00
<p>
2022-09-13 16:55:41 +08:00
<a href="http://tdesign.tencent.com/starter/vue-next/">Live Preview</a>
2022-06-08 14:36:50 +08:00
·
2022-09-13 16:55:41 +08:00
<a href="https://tdesign.tencent.com/starter/">Documentation</a>
</p>
2021-12-16 12:24:51 +08:00
<img src="docs/starter.png">
2021-12-16 12:06:40 +08:00
### Features
2021-12-16 12:06:40 +08:00
- Various provided pages for develop
2022-09-13 16:55:41 +08:00
- Complete directory structure for develop
- Code specification configuration
- Support dark mode
- Custom theme colors
- Various space layouts
2022-09-13 16:55:41 +08:00
- Mock data scheme
2021-12-16 12:06:40 +08:00
### Usage
2021-12-16 12:06:40 +08:00
2022-09-13 16:55:41 +08:00
> Initialize project with our CLI tool `tdesign-starter-cli`
2021-12-16 12:06:40 +08:00
```bash
## install tdesign-starter-cli
2021-12-16 12:06:40 +08:00
npm i tdesign-starter-cli@latest -g
2022-09-13 16:55:41 +08:00
## create project
2021-12-16 12:06:40 +08:00
td-starter init
```
2021-12-16 12:06:40 +08:00
### Develop
2021-12-16 12:06:40 +08:00
```bash
## install dependencies
npm install
## set up
2021-12-10 03:07:40 +08:00
npm run dev
2021-12-16 12:06:40 +08:00
```
### Build
2021-12-16 12:06:40 +08:00
```bash
## build
npm run build
## build for test
2021-12-16 12:06:40 +08:00
npm run build:test
```
2022-09-13 16:55:41 +08:00
### Contributing Guide
2022-09-13 16:55:41 +08:00
We welcome contributions to our project. Create your [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls).
2021-12-16 12:06:40 +08:00
#### 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
2021-12-16 12:06:40 +08:00
- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories)
### Compatibility
2021-12-23 17:20:16 +08:00
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br> IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
2022-06-08 14:36:50 +08:00
2022-09-13 16:55:41 +08:00
### License
2022-09-13 16:55:41 +08:00
The MIT License. Please see [the license file](LICENSE) for more information.