tdesign-vue-next-starter/README.md

118 lines
5.0 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>
### 项目简介
2021-12-16 12:09:00 +08:00
TDesign Vue Next Starter 是一个基于 TDesign。使用 `Vue3`、`Vite2`、`TypeScript` 开发,可进行个性化主题配置,旨在提供项目开箱即用的、配置式的中后台项目。
2021-12-16 12:06:40 +08:00
<p>
<a href="http://tdesign.tencent.com/starter/vue-next/">在线预览</a>
.
<a href="https://tdesign.tencent.com/starter/">使用文档</a>
</p>
2021-12-16 12:24:51 +08:00
<img src="docs/starter.png">
2021-12-16 12:06:40 +08:00
### 特性
- 内置多种常用的中后台页面
- 完善的目录结构
- 完善的代码规范配置
- 支持暗黑模式
- 自定义主题颜色
- 多种空间布局
- 内置 Mock 数据方案
### 使用
> 通过 `tdesign-starter-cli` 初始化项目仓库
2021-12-16 12:06:40 +08:00
```bash
## 1、安装 tdesign-starter-cli
npm i tdesign-starter-cli@latest -g
2021-12-16 12:06:40 +08:00
## 2、创建项目
td-starter init
```
2021-12-16 12:06:40 +08:00
### 开发
``` bash
## 安装依赖
npm install
2021-12-16 12:06:40 +08:00
## 启动项目
2021-12-10 03:07:40 +08:00
npm run dev
2021-12-16 12:06:40 +08:00
```
2021-12-16 12:06:40 +08:00
### 构建
2021-12-16 12:06:40 +08:00
```bash
## 构建正式环境
npm run build
2021-12-16 12:06:40 +08:00
## 构建测试环境
npm run build:test
```
### 其他
```bash
## 预览构建产物
npm run preview
2021-12-16 12:06:40 +08:00
## 代码格式检查
npm run lint
2021-12-16 12:06:40 +08:00
## 代码格式检查与自动修复
npm run lint:fix
2021-12-16 12:06:40 +08:00
## style格式检查
npm run stylelint
2021-12-16 12:06:40 +08:00
## style格式检查与自动修复
npm run stylelint:fix
```
2021-12-16 12:06:40 +08:00
### 如何贡献
2021-12-16 12:06:40 +08:00
非常欢迎您的贡献!提交您的 [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) 或者提交 [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls)。
2021-12-16 12:06:40 +08:00
#### Pull Request
2021-12-16 12:06:40 +08:00
1. Fork 代码!
2. 创建自己的分支: `git checkout -b feat/xxxx`
3. 提交你的修改: `git commit -a 'feat(project): describe'`
4. 推送您的分支: `git push origin feat/xxxx`
5. 提交 `pull request`
2021-12-16 12:06:40 +08:00
#### 贡献提交规范
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)
2021-12-16 12:06:40 +08:00
### 兼容性
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 |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2022-02-15 10:49:19 +08:00
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
2021-12-16 12:06:40 +08:00
### License
2021-12-16 12:06:40 +08:00
[MIT](./LICENSE)