Skip to content

snail-uni - 专为开发者打造的 UniApp 框架模板。 基于 UniApp + Vue3 + TypeScript + Vite + Wot Design Uni 的高效框架模板。它内置了 Snail-Uni 脚手架工具,帮助您快速创建 TypeScript 或 JavaScript 版本项目。Snail-Uni 配备了丰富的开箱即用配置,让您从一开始就拥有高效的开发体验。

License

Notifications You must be signed in to change notification settings

hu-snail/snail-uni

Repository files navigation

Snail-uni logo

Snail-uni

更懂你的uni-app框架

github stars github forks gitee stars gitee forks node version pnpm version

snail-uni - 专为开发者打造的 UniApp 框架模板。 基于 UniApp + Vue3 + TypeScript + Vite + Wot Design Uni 的高效框架模板。它内置了 Snail-Uni 脚手架工具,帮助您快速创建 TypeScriptJavaScript 版本项目。Snail-Uni 配备了丰富的开箱即用配置,让您从一开始就拥有高效的开发体验。

⭐️ 特性

  • 💡 使用 Vue3 + Vite5 + Ts 等最新技术栈构建
  • 📦 采用 pnpm + Monorepo 模式构建
  • ⚡️ 路由自动注册,无需手动配置路由,同时集成了Uni Mini Router路由插件系统
  • 🌱 集成 Oxlint + Eslint 最新的代码规范,更高效的检测代码质量
  • 🛠️ 宇宙最强编辑器Vscode,告别HBuilderX
  • 💻 支持uni-appvue3piniauni mini router自动导入
  • 🍒 支持微信云开发 (开发中)

✍️ 创建项目

🌱 一.命令导向方式

# npm
npm create snail-uni@latest
# pnpm
pnpm create snail-uni 
# yarn
yarn create snail-uni
# bun
bun create snail-uni

🌿 二.命令行选项

命令行支持两种方式创建:

🌾 方式一

npm create snail-uni <project-name> --t <template-name 模板名称> --ui <ui库(Wot-Design/Uv-ui/Uview-plus/TuniaoUI> --lint <yes/no)>

# npm
npm create snail-uni@latest my-snail-app --t uni-ts --ui Uv-ui  --lint yes
# pnpm
pnpm create snail-uni my-snail-app --t uni-ts --ui Uv-ui  --lint yes
# yarn
yarn create snail-uni my-snail-app --t uni-ts --ui Uv-ui  --lint yes
# bun
bun create snail-uni my-snail-app --t uni-ts --ui Uv-ui  --lint yes
  • 支持以下模板:uni-tsuni-tabbar-tsuni-jsuni-tabbar-js
  • 支持以下ui库:Wot-DesignUv-uiUview-plusTuniaoUI

🌲 方式二

npm create snail-uni <project-name> <语言类型(js/ts)> <是否使用(tabbar/no)> <是否使用代码检查(eslint/no)> <ui库(Wot-Design/Uv-ui/Uview-plus/TuniaoUI)>

# npm
# 创建 ts、tabbar、eslint版本 
npm create snail-uni snail-uni-app ts tabbar eslint
# pnpm
pnpm create snail-uni snail-uni-app ts tabbar eslint
# yarn
yarn create snail-uni snail-uni-app ts tabbar eslint
# bun
bun create snail-uni snail-uni-app ts tabbar eslint

执行完之后,将生成一个 uni-app 的项目

📚 启动并运行

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 dev
# Yarn
yarn dev
# Bun
bun run dev

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

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

# npm
npm run build
# pnpm
pnpm build
# Yarn
yarn build
# Bun
bun run build

About

snail-uni - 专为开发者打造的 UniApp 框架模板。 基于 UniApp + Vue3 + TypeScript + Vite + Wot Design Uni 的高效框架模板。它内置了 Snail-Uni 脚手架工具,帮助您快速创建 TypeScript 或 JavaScript 版本项目。Snail-Uni 配备了丰富的开箱即用配置,让您从一开始就拥有高效的开发体验。

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published