快速开始

前置准备

• Node.js 18 及以上版本
• pnpm - >=8.15.6（推荐使用 9.0.0）
• VSCode 开发工具下载
• HBuilderX - APP 的运行和发布需要
• Git 安装

注：无需App开发，则无需下载HBuilderX

Vscode插件安装

snail-uni内置了插件安装配置文件，使用Vscode打开项目文件夹，点击安装插件即可安装插件。

├── .vscode
│   └── extensions.json

创建项目

snail-uni 附带一个命令行创建向导，可以帮助你构建一个基本项目。支持创建 js 与 ts 让你无需纠结。

npm

npx snail-uni create

pnpm

pnpm snail-uni create

yarn

yarn snail-uni create

将需要回答几个简单的问题：

┌  欢迎使用snail-uni脚手架!
│
◇  项目名称:
│  snai-uni-app
│
◇   项目描述:
│  A snail-uni-app project
│
◆  选择 UI 框架:
│  ● wot-design-ui (推荐) 
│  ○ uv-ui
│  ○ uview-plus
│  ○ tuniao-ui
│
◆  是否使用 TypeScript?
│  ● Yes  / ○ No
│
└  你已成功创建! 现在请使用 pnpm 安装/运行你的项目

   进入项目： cd snail-uni-app
   安装依赖： pnpm install

你还可以通过附加的命令行选项直接指定项目名称和你想要使用的模板, 例如： snail-uni create <project-name> <语言类型（js/ts）> 不指定类型默认为 js 版本， ts版本如下：

npm

npx snail-uni create snail-uni-app ts

pnpm

pnpm snail-uni create snail-uni-app ts

yarn

yarn snail-uni create  snail-uni-app ts

执行完之后，将生成一个新的项目

└  你已成功创建! 现在请使用 pnpm 安装/运行你的项目

   进入项目： cd snail-uni-app
   安装依赖： pnpm install

启动并运行

snail-uni 启动运行脚本在package.json中配置：

{
  ...
  "scripts": {
    "dev": "uni -p mp-weixin",
    "dev:h5": "uni",
    "build": "uni build -p mp-weixin",
    "build:h5": "uni build"
    ...
  },
  ...
}

dev 脚本将启动具有即时热更新的本地开发服务器。使用以下命令运行它：

默认启动微信小程序,根据自己需求在package.json 中进行调整

npm

npm run dev

pnpm

pnpm run dev # or pnpm dev

yarn

yarn dev

build 脚本将构建应用，并生成一个或多个平台包。使用以下命令运行它：

默认构建微信小程序,根据自己需求在package.json 中进行调整

npm

npm run build

pnpm

pnpm run build # or pnpm build

yarn

yarn build