Skip to content

Commit 028db05

Browse files
committed
docs: update readme
1 parent c399ef3 commit 028db05

3 files changed

Lines changed: 120 additions & 13 deletions

File tree

LICENSE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright (c) 2021-present TDesign
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 111 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,130 @@
1-
# tdesign-uniapp-vue2-cli
1+
<p align="center">
2+
<a href="https://tdesign.tencent.com/" target="_blank">
3+
<img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/site/TDesign.png">
4+
</a>
5+
</p>
26

3-
[TDesign UniApp](https://www.npmjs.com/package/tdesign-uniapp) 示例,Vue2 + CLI 模式。
7+
<p align="center">
8+
<a href="https://v2.vuejs.org/"><img src="https://img.shields.io/badge/Vue-2.6-brightgreen.svg" alt="Vue2" /></a>
9+
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-4.5-blue.svg" alt="TypeScript" /></a>
10+
<a href="https://webpack.js.org/"><img src="https://img.shields.io/badge/Webpack-5-purple.svg" alt="Webpack" /></a>
11+
<a href="https://tdesign.tencent.com/uniapp/getting-started"><img src="https://img.shields.io/badge/TDesign-Uniapp-0052d9.svg" alt="TDesign" /></a>
12+
<a href="https://github.com/TDesignOteam/tdesign-uniapp-starter-vue2-cli/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License" /></a>
13+
</p>
414

5-
## 安装依赖
15+
# TDesign Uniapp 组件库模板 (Vue 2 CLI)
616

7-
```bash
8-
npm install
9-
```
17+
基于 Vue 2 + TypeScript + Webpack (Vue CLI) + TDesign Uniapp 的跨端移动应用开发模板,支持 H5、微信小程序、支付宝小程序等多平台。
18+
19+
## ✨ 特性
20+
21+
- 🎨 **TDesign 组件库** - 腾讯出品的企业级设计体系
22+
- 📦 **开箱即用** - 完整的项目结构和配置
23+
- 🔧 **TypeScript** - 完整的类型支持
24+
-**Vue CLI + Webpack** - 稳定成熟的构建体验
25+
- 🌐 **多平台支持** - H5 / 微信 / 支付宝 / 抖音 / QQ / 百度 / 快手 / 京东 / 小红书等
26+
27+
## 🔧 环境要求
28+
29+
- **Node.js**: >= 14.0.0
30+
- **npm**: >= 6.0.0
1031

11-
## 开发
32+
## 🚀 快速开始
1233

1334
```bash
35+
# 克隆项目
36+
git clone https://github.com/TDesignOteam/tdesign-uniapp-starter-vue2-cli.git
37+
38+
# 进入项目目录
39+
cd tdesign-uniapp-starter-vue2-cli
40+
41+
# 安装依赖
42+
npm install
43+
44+
# 启动 H5 开发
1445
npm run dev:h5
46+
47+
# 启动微信小程序开发
1548
npm run dev:mp-weixin
1649
```
1750

18-
## 打包
51+
## 📱 多平台开发
1952

20-
```bash
21-
npm run build:h5
22-
npm run build:mp-weixin
23-
```
53+
### 开发模式
2454

25-
## 调试
55+
| 平台 | 命令 |
56+
| ------------ | ------------------------- |
57+
| H5 | `npm run dev:h5` |
58+
| 微信小程序 | `npm run dev:mp-weixin` |
59+
| 支付宝小程序 | `npm run dev:mp-alipay` |
60+
| 抖音小程序 | `npm run dev:mp-toutiao` |
61+
| QQ 小程序 | `npm run dev:mp-qq` |
62+
| 百度小程序 | `npm run dev:mp-baidu` |
63+
| 快手小程序 | `npm run dev:mp-kuaishou` |
64+
| 京东小程序 | `npm run dev:mp-jd` |
65+
| 飞书小程序 | `npm run dev:mp-lark` |
66+
| 小红书小程序 | `npm run dev:mp-xhs` |
67+
| 鸿蒙元服务 | `npm run dev:mp-harmony` |
68+
69+
### 生产构建
70+
71+
| 平台 | 命令 |
72+
| ------------ | --------------------------- |
73+
| H5 | `npm run build:h5` |
74+
| 微信小程序 | `npm run build:mp-weixin` |
75+
| 支付宝小程序 | `npm run build:mp-alipay` |
76+
| 抖音小程序 | `npm run build:mp-toutiao` |
77+
| QQ 小程序 | `npm run build:mp-qq` |
78+
| 百度小程序 | `npm run build:mp-baidu` |
79+
| 快手小程序 | `npm run build:mp-kuaishou` |
80+
| 京东小程序 | `npm run build:mp-jd` |
81+
| 飞书小程序 | `npm run build:mp-lark` |
82+
| 小红书小程序 | `npm run build:mp-xhs` |
83+
| 鸿蒙元服务 | `npm run build:mp-harmony` |
84+
85+
## 🔗 调试
2686

2787
开发和构建命令传递 `--alias`,即可使用本地的 `tdesign-uniapp``tdesign-uniapp-chat`,否则会使用 `npm` 中的相应包。
2888

2989
```bash
3090
npm run dev:h5 -- --alias
3191
npm run dev:mp-weixin -- --alias
3292
```
93+
94+
## 📁 项目结构
95+
96+
```
97+
├── src/
98+
│ ├── components/ # 公共组件
99+
│ ├── mixins/ # 混入
100+
│ ├── pages/ # 主页面目录
101+
│ ├── pages-more/ # 更多页面(组件示例)
102+
│ ├── static/ # 静态资源
103+
│ ├── style/ # 全局样式
104+
│ ├── App.vue # 根组件
105+
│ ├── main.js # 入口文件
106+
│ ├── pages.json # 页面路由配置
107+
│ ├── manifest.json # 应用配置
108+
│ └── uni.scss # uni-app 全局样式变量
109+
├── public/ # 公共资源
110+
├── babel.config.js # Babel 配置
111+
├── vue.config.js # Vue CLI 配置
112+
├── postcss.config.js # PostCSS 配置
113+
├── tsconfig.json # TypeScript 配置
114+
└── package.json # 项目依赖
115+
```
116+
117+
## 🔗 相关链接
118+
119+
- [TDesign Uniapp 组件库](https://tdesign.tencent.com/uniapp/getting-started)
120+
- [uni-app 官方文档](https://uniapp.dcloud.net.cn/)
121+
- [Vue 2 文档](https://v2.vuejs.org/)
122+
- [Vue CLI 文档](https://cli.vuejs.org/)
123+
124+
## 📱 扫码预览
125+
126+
<img src="./docs/image/tdesign-uniapp-starter-vue2-cli-h5" width="300" />
127+
128+
## 📄 License
129+
130+
[MIT](LICENSE)
7.78 KB
Loading

0 commit comments

Comments
 (0)