create-uniapps 1.0.5 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +167 -43
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,67 +1,191 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 🌈 uni-preset-vue 模板说明文档
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
一个基于 **Vue3 + TypeScript + Vite + Pinia + TailwindCSS** 的 `uni-app` 模板，内置多端开发环境配置，支持一键运行微信小程序、H5、App 及各类小程序平台。
|
|
4
|
+
本模板旨在快速搭建跨端项目，统一前端开发规范，提高开发效率。
|
|
5
5
|
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## 📦 技术栈
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
10
|
+
| 技术 | 说明 |
|
|
11
|
+
| ---------------------------------- | ---------------------- |
|
|
12
|
+
| **Vue 3** | 渐进式前端框架 |
|
|
13
|
+
| **TypeScript** | 静态类型检查 |
|
|
14
|
+
| **Vite** | 高性能构建工具 |
|
|
15
|
+
| **Pinia** | 轻量级状态管理 |
|
|
16
|
+
| **TailwindCSS** | 原子化 CSS 框架 |
|
|
17
|
+
| **VueUse** | Vue3 实用工具库 |
|
|
18
|
+
| **Iconify** | 图标库整合方案 |
|
|
19
|
+
| **Day.js** | 日期处理库 |
|
|
20
|
+
| **Crypto-js / js-md5 / js-base64** | 数据加密与编码工具 |
|
|
21
|
+
| **ESLint + Prettier** | 统一代码风格与语法检查 |
|
|
18
22
|
|
|
19
23
|
---
|
|
20
24
|
|
|
21
|
-
##
|
|
25
|
+
## 🚀 快速开始
|
|
22
26
|
|
|
23
|
-
###
|
|
27
|
+
### 1️⃣ 安装依赖
|
|
24
28
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
29
|
+
```bash
|
|
30
|
+
pnpm install
|
|
31
|
+
# 或
|
|
32
|
+
npm install
|
|
33
|
+
# 或
|
|
34
|
+
yarn
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### 2️⃣ 启动开发
|
|
28
38
|
|
|
29
|
-
|
|
39
|
+
可根据需要启动不同端的调试模式：
|
|
30
40
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
41
|
+
| 命令 | 平台说明 |
|
|
42
|
+
| ------------------------------ | ------------------- |
|
|
43
|
+
| `npm run dev:h5` | 运行 H5 页面 |
|
|
44
|
+
| `npm run dev:mp-weixin` | 运行微信小程序 |
|
|
45
|
+
| `npm run dev:mp-alipay` | 运行支付宝小程序 |
|
|
46
|
+
| `npm run dev:mp-toutiao` | 运行字节跳动小程序 |
|
|
47
|
+
| `npm run dev:mp-baidu` | 运行百度小程序 |
|
|
48
|
+
| `npm run dev:mp-qq` | 运行 QQ 小程序 |
|
|
49
|
+
| `npm run dev:mp-xhs` | 运行小红书小程序 |
|
|
50
|
+
| `npm run dev:quickapp-webview` | 运行快应用 |
|
|
51
|
+
| `npm run dev:h5:ssr` | 运行 SSR 模式（H5） |
|
|
37
52
|
|
|
38
|
-
|
|
53
|
+
---
|
|
39
54
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
55
|
+
### 3️⃣ 打包构建
|
|
56
|
+
|
|
57
|
+
| 命令 | 说明 |
|
|
58
|
+
| -------------------------------- | ---------------- |
|
|
59
|
+
| `npm run build:h5` | 构建 H5 版本 |
|
|
60
|
+
| `npm run build:mp-weixin` | 构建微信小程序 |
|
|
61
|
+
| `npm run build:mp-alipay` | 构建支付宝小程序 |
|
|
62
|
+
| `npm run build:mp-toutiao` | 构建字节小程序 |
|
|
63
|
+
| `npm run build:h5:ssr` | 构建 SSR H5 |
|
|
64
|
+
| `npm run build:quickapp-webview` | 构建快应用 |
|
|
45
65
|
|
|
46
66
|
---
|
|
47
67
|
|
|
48
|
-
##
|
|
68
|
+
## 🧩 项目结构
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
uni-preset-vue/
|
|
72
|
+
├── src/
|
|
73
|
+
│ ├── pages/ # 页面目录
|
|
74
|
+
│ ├── components/ # 公共组件
|
|
75
|
+
│ ├── store/ # Pinia 状态管理
|
|
76
|
+
│ ├── utils/ # 工具函数与封装
|
|
77
|
+
│ ├── locales/ # i18n 国际化配置
|
|
78
|
+
│ ├── styles/ # 全局样式与 Tailwind 配置
|
|
79
|
+
│ └── main.ts # 入口文件
|
|
80
|
+
│
|
|
81
|
+
├── uni_modules/ # uni-app 模块目录
|
|
82
|
+
├── static/ # 静态资源
|
|
83
|
+
├── package.json
|
|
84
|
+
├── vite.config.ts
|
|
85
|
+
├── tsconfig.json
|
|
86
|
+
└── README.md
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
---
|
|
49
90
|
|
|
50
|
-
|
|
91
|
+
## 🧠 开发规范
|
|
51
92
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
93
|
+
### 代码规范
|
|
94
|
+
|
|
95
|
+
- 使用 **TypeScript** 编写逻辑。
|
|
96
|
+
|
|
97
|
+
- 使用 **ESLint + Prettier + Tailwind** 进行自动格式化。
|
|
98
|
+
|
|
99
|
+
- 提交前执行：
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
npm run type-check
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
确保类型检查通过。
|
|
106
|
+
|
|
107
|
+
### 目录规范
|
|
108
|
+
|
|
109
|
+
- 页面统一放在 `src/pages/`
|
|
110
|
+
- 公共组件放在 `src/components/`
|
|
111
|
+
- 全局状态放在 `src/store/`
|
|
112
|
+
- 工具函数放在 `src/utils/`
|
|
113
|
+
- 样式配置统一放在 `src/styles/`
|
|
58
114
|
|
|
59
115
|
---
|
|
60
116
|
|
|
61
|
-
##
|
|
117
|
+
## 🧰 常用依赖说明
|
|
62
118
|
|
|
63
|
-
|
|
119
|
+
| 依赖 | 用途 |
|
|
120
|
+
| ------------------------------------ | -------------- |
|
|
121
|
+
| `@vueuse/core` | 常用组合式函数 |
|
|
122
|
+
| `dayjs` | 时间格式化 |
|
|
123
|
+
| `crypto-js` / `js-md5` / `js-base64` | 数据加密与签名 |
|
|
124
|
+
| `qs` | 请求参数序列化 |
|
|
125
|
+
| `@iconify/vue` | 图标组件 |
|
|
126
|
+
| `pinia` | 全局状态管理 |
|
|
127
|
+
| `vue-i18n` | 多语言支持 |
|
|
64
128
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## 🧪 检查与优化
|
|
132
|
+
|
|
133
|
+
| 命令 | 功能 |
|
|
134
|
+
| -------------------- | --------------------------- |
|
|
135
|
+
| `npm run type-check` | 类型检查 |
|
|
136
|
+
| `npm run lint` | 语法检查 |
|
|
137
|
+
| `npm run format` | 自动格式化（结合 Prettier） |
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
|
|
141
|
+
## 🌍 支持平台
|
|
142
|
+
|
|
143
|
+
| 平台 | 是否支持 |
|
|
144
|
+
| --------------------- | -------- |
|
|
145
|
+
| H5 | ✅ |
|
|
146
|
+
| 微信小程序 | ✅ |
|
|
147
|
+
| 支付宝小程序 | ✅ |
|
|
148
|
+
| 抖音小程序 | ✅ |
|
|
149
|
+
| 百度小程序 | ✅ |
|
|
150
|
+
| QQ 小程序 | ✅ |
|
|
151
|
+
| 快应用 | ✅ |
|
|
152
|
+
| HarmonyOS (鸿蒙 NEXT) | ✅ |
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## 💡 开发建议
|
|
157
|
+
|
|
158
|
+
1. 推荐使用 **VSCode** 搭配以下插件：
|
|
159
|
+
|
|
160
|
+
- 🌟 `Volar`（Vue 3 支持）
|
|
161
|
+
- 🌟 `ESLint`
|
|
162
|
+
- 🌟 `Tailwind CSS IntelliSense`
|
|
163
|
+
- 🌟 `Iconify IntelliSense`
|
|
164
|
+
|
|
165
|
+
2. 若需自定义端平台启动，请修改 `package.json` 中的 `scripts` 命令。
|
|
166
|
+
|
|
167
|
+
3. 统一风格建议使用 `prettier-plugin-tailwindcss` 自动调整类名顺序。
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
## 🧾 License
|
|
172
|
+
|
|
173
|
+
本项目模板仅供学习与快速开发使用。
|
|
174
|
+
如需商用或二次封装，请保留原作者说明或在适当位置注明出处。
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## 👨💻 作者信息
|
|
179
|
+
|
|
180
|
+
- 作者：josef
|
|
181
|
+
- 模板名称：`uni-preset-vue`
|
|
182
|
+
- 创建时间：2025 年
|
|
183
|
+
- 版本：v1.0.0
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## 📅 更新日志
|
|
188
|
+
|
|
189
|
+
| 日期 | 版本 | 内容 |
|
|
190
|
+
| ---------- | ------ | -------------- |
|
|
191
|
+
| 2025-10-13 | v1.0.0 | 初始化项目模板 |
|