快速上手

创建一个 Vue Mini 小程序

前提条件

• 熟悉命令行
• 已安装 >= 18.19.1 < 19 或 >= 20.6.1 版本的 Node.js

创建 Vue Mini 小程序最推荐的方案是 create-vue-mini，它是官方项目脚手架工具。你可以在终端内直接运行以下命令（不要带上 $ 符号）：

npm

$ npm create vue-mini@latest

pnpm

$ pnpm create vue-mini@latest

yarn

$ yarn create vue-mini

然后你将会看到一些诸如 TypeScript 和测试支持之类的可选功能提示：

✔ 请输入项目名称：… <your-project-name>
✔ 是否使用 TypeScript 语法？… 否 / 是
✔ 是否引入 Vitest 用于单元测试？… 否 / 是
✔ 是否引入 ESLint 用于 JS 代码质量检测？… 否 / 是
✔ 是否引入 Stylelint 用于 CSS 代码质量检测？… 否 / 是
✔ 是否引入 Prettier 用于代码格式化？… 否 / 是

正在初始化项目 ./<your-project-name>...
项目初始化完成。

如果不确定是否要开启某个功能，你可以直接按下回车键选择否。在项目被创建后，通过以下步骤安装依赖并启动开发服务器：

npm

$ cd <your-project-name>
$ npm install
$ npm run dev

pnpm

$ cd <your-project-name>
$ pnpm install
$ pnpm run dev

yarn

$ cd <your-project-name>
$ yarn
$ yarn dev

你现在应该已经运行起来了你的第一个 Vue Mini 项目！现在你可以将项目导入微信开发者工具，注意选择项目根目录而非 dist 目录。

当你准备将小程序发布上线时，请运行：

npm

$ npm run build

pnpm

$ pnpm run build

yarn

$ yarn build

然后使用微信开发者工具上传。请忽略微信开发者工具关于 JS 代码未压缩的警告，上述命令已经对 JS 代码做了自定义压缩。

使用包管理器安装

你也可以使用下列命令安装 Vue Mini：

npm

$ npm install @vue-mini/core

pnpm

$ pnpm install @vue-mini/core

yarn

$ yarn add @vue-mini/core

从 GitHub 下载

当然，使用 Vue Mini 最简单的方式就是直接从 GitHub 下载编译好的文件压缩包，解压缩后拷贝到你的项目中，然后像使用你自己的文件一样使用 Vue Mini。你可以根据自身情况选择需要的文件。