mirror of
https://github.com/Tencent/tdesign-vue-next-starter.git
synced 2024-09-19 18:24:20 +08:00
A starter-kit for TDesign Vue Next UI components
| .github | ||
| .husky | ||
| .vscode | ||
| docs | ||
| mock | ||
| public | ||
| src | ||
| .editorconfig | ||
| .env | ||
| .env.development | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .npmrc | ||
| .prettierrc.js | ||
| .stylelintignore | ||
| commitlint.config.js | ||
| index.html | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| stylelint.config.js | ||
| tsconfig.json | ||
| vite.config.ts | ||
项目简介
TDesign Vue Next Starter 是一个基于 TDesign。使用 Vue3、Vite2、Pinia、TypeScript 开发，可进行个性化主题配置，旨在提供项目开箱即用的、配置式的中后台项目。
特性
- 内置多种常用的中后台页面
- 完善的目录结构
- 完善的代码规范配置
- 支持暗黑模式
- 自定义主题颜色
- 多种空间布局
- 内置 Mock 数据方案
使用
通过
tdesign-starter-cli初始化项目仓库
## 1、安装 tdesign-starter-cli
npm i tdesign-starter-cli@latest -g
## 2、创建项目
td-starter init
开发
## 安装依赖
npm install
## 启动项目
npm run dev
构建
## 构建正式环境
npm run build
## 构建测试环境
npm run build:test
其他
## 预览构建产物
npm run preview
## 代码格式检查
npm run lint
## 代码格式检查与自动修复
npm run lint:fix
## style格式检查
npm run stylelint
## style格式检查与自动修复
npm run stylelint:fix
如何贡献
非常欢迎您的贡献！提交您的 Issue 或者提交 Pull Request。
Pull Request
- Fork 代码!
- 创建自己的分支:
git checkout -b feat/xxxx - 提交你的修改:
git commit -a 'feat(project): describe' - 推送您的分支:
git push origin feat/xxxx - 提交
pull request
贡献提交规范
兼容性
 IE / Edge |
 Firefox |
 Chrome |
 Safari |
|---|---|---|---|
| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
开源协议
TDesign 遵循 MIT 协议。