uniApp项目创建

1. 通过 HBuilderX 创建项目

uni-app支持通过 可视化界面、vue-cli命令行 两种方式快速创建项目。

可视化的方式比较简单，HBuilderX内置相关环境，开箱即用，无需配置nodejs。

开始之前，开发者需先下载安装如下工具：

HBuilderX：官方IDE下载地址
HBuilderX是通用的前端开发工具，但为uni-app做了特别强化。

1.1 创建uni-app

在点击工具栏里的文件 -> 新建 -> 项目（快捷键Ctrl+N）：
 

选择uni-app类型，输入工程名，选择模板，点击创建，即可成功创建。

uni-app自带的模板有 默认的空项目模板、Hello uni-app 官方组件和API示例，还有一个重要模板是 uni ui项目模板，日常开发推荐使用该模板，已内置大量常用组件。

1.2 运行uni-app

1.浏览器运行：进入hello-uniapp项目，点击工具栏的运行 -> 运行到浏览器 -> 选择浏览器，即可体验 uni-app 的 web 版。

2.运行App到手机或模拟器：使用电压足够的usb端口连接手机，设置中开启USB调试，手机上允许电脑设备调试手机，进入hello-uniapp项目，点击工具栏的运行 -> 运行App到手机或模拟器，即可在该设备里面体验uni-app。

3.在微信开发者工具里运行：进入hello-uniapp项目，点击工具栏的运行 -> 运行到小程序模拟器 -> 微信开发者工具，即可在微信开发者工具里面体验uni-app。

注意：如果是第一次使用，需要先配置小程序ide的相关路径，才能运行成功。如下图，需在输入框输入微信开发者工具的安装路径。

4.在支付宝小程序开发者工具里运行：进入hello-uniapp项目，点击工具栏的运行 -> 运行到小程序模拟器 -> 支付宝小程序开发者工具，即可在支付宝小程序开发者工具里面体验uni-app。

5.在百度、字节跳动、QQ、快应用（分联盟和华为）、快手、飞书、360、京东等小程序开发工具里运行：内容同上，不再重复。

Tips

• 如果是第一次使用，需要配置开发工具的相关路径。点击工具栏的运行 -> 运行到小程序模拟器 -> 运行设置，配置相应小程序开发者工具的路径。
• 微信小程序工具需要配置允许权限，不然HBuilder无法调用微信小程序开发工具的命令行
• 支付宝/百度/字节跳动/360小程序工具，不支持直接指定项目启动并运行。因此开发工具启动后，请将 HBuilderX 控制台中提示的项目路径，在相应小程序开发者工具中打开。
• 如果自动启动小程序开发工具失败，请手动启动小程序开发工具并将 HBuilderX 控制台提示的项目路径，打开项目。

运行的快捷键是Ctrl+R。

HBuilderX 还提供了快捷运行菜单，可以按数字快速选择要运行的设备：

2.通过 cli 创建项目

除了HBuilderX可视化界面，也可以使用 cli 脚手架，可以通过 vue-cli 创建 uni-app 项目。

2.1 环境安装

全局安装 vue-cli

npm install -g @vue/cli

2.2 创建uni-app

• 使用正式版（对应HBuilderX最新正式版）

  vue create -p dcloudio/uni-preset-vue my-project

• 使用alpha版（对应HBuilderX最新alpha版）

  vue create -p dcloudio/uni-preset-vue#alpha my-alpha-project

• 使用Vue3/Vite版
  • 创建以 javascript 开发的工程（如命令行创建失败，请直接访问 gitee 下载模板）

    npx degit dcloudio/uni-preset-vue#vite my-vue3-project

  • 创建以 typescript 开发的工程（如命令行创建失败，请直接访问 gitee 下载模板）

    npx degit dcloudio/uni-preset-vue#vite-ts my-vue3-project

此时，会提示选择项目模板（使用Vue3/Vite版不会提示，目前只支持创建默认模板），初次体验建议选择 hello uni-app 项目模板，如下所示：

注意

• Vue3/Vite版要求 node 版本^14.18.0 ||>=16.0.0
• 如果使用 HBuilderX（3.6.7以下版本）运行 Vue3/Vite 创建的最新的 cli 工程，需要在 HBuilderX 运行配置最底部设置 node路径 为自己本机高版本 node 路径（注意需要重启 HBuilderX 才可以生效）
  • HBuilderX Mac 版本菜单栏左上角 HBuilderX->偏好设置->运行配置->node路径
  • HBuilderX Windows 版本菜单栏 工具->设置->运行配置->node路径

2.3 自定义模板

选择自定义模板时，需要填写 uni-app 模板地址，这个地址其实就是托管在云端的仓库地址。以 GitHub 为例，地址格式为 userName/repositoryName，如 dcloudio/uni-template-picture 就是下载图片模板。

更多支持的下载方式，请参考这个插件的说明：download-git-repo

2.4 国内特殊情况

模板项目存放于 Github，由于国内网络环境问题，可能下载失败。针对此问题可以尝试如下措施：

• 更换网络重试，比如使用 4g 网络
• 在设备或路由器的网络设置中增加 DNS（如：8.8.8.8）
• 在设备中增加固定的 hosts（如：140.82.113.4 github.com）

2.5 修改依赖为指定版本

可以使用 @dcloudio/uvm"target="_blank" title="@dcloudio/uvm">@dcloudio/uvm 管理编译器的版本，此工具仅自动增加或更新 uni-app 编译器主要依赖，对于新增的编译命令（scripts）暂时不会自动处理，需手动参考新工程进行配置。

• 更新到最新正式版

  npx @dcloudio/uvm

• 更新到最新 alpha 版

  npx @dcloudio/uvm alpha

• 更新到正式版指定版本

  npx @dcloudio/uvm 3.2.0

  npx @dcloudio/uvm 3.2.12.20211029

• 更新到 alpha 版指定版本

  npx @dcloudio/uvm 3.2.0-alpha

  npx @dcloudio/uvm 3.2.14.20211112-alpha

  2.6 运行、发布uni-app

npm run dev:%PLATFORM%
npm run build:%PLATFORM%

%PLATFORM%可取值如下：

值	平台
app-plus	app平台生成打包资源（支持npm run build:app-plus，可用于持续集成。不支持run，运行调试仍需在HBuilderX中操作）
h5	h5
mp-alipay	支付宝小程序
mp-baidu	百度小程序
mp-weixin	微信小程序
mp-toutiao	字节跳动小程序
mp-lark	飞书小程序
mp-qq	qq 小程序
mp-360	360 小程序
mp-kuaishou	快手小程序
mp-jd	京东小程序
mp-xhs	小红书小程序
quickapp-webview	快应用(webview)
quickapp-webview-union	快应用联盟
quickapp-webview-huawei	快应用华为