uni-helper / create-uni

🛠️快速创建uni-app项目
https://uni-helper.js.org/create-uni
MIT License
83 stars 7 forks source link
cli-app uni-app vue3

✨💚create uni💚✨

>_ Easy to use create uni▌

📦 使用

# npm
    npm create uni@latest

# yarn
    yarn create uni

# pnpm
    pnpm create uni

[!TIP] 建议添加上标记名(@latest),否则 npm 可能会解析到缓存的过时软件包版本。

📖 介绍

create-uni 是一个用于快速创建 uni-app 项目的轻量脚手架工具,它可以帮助你快速创建一个基于vitevue3uni-app项目,同时提供了一些模板供你选择。

🚤 快速使用

npm create uni <项目名称> --ts -m pinia -m uniUse -u ano -e
npx create-uni@latest --info
# --info  获取当前项目环境信息

参数说明

配置项 参数 别名 可选值
Template —— t 模板列表
TypeScript ts —— ——
Plugin pluginList p 插件列表
Module moduleList m 模块列表
UI ui u 组件列表
Eslint eslint e ——
info info —— all

📦模板列表

模板名 描述 参数名
vitesse-uni-app 由 Vite & uni-app 驱动的跨端快速启动模板 vitesse
wot-demo 基于 vitesse-uni-app 的 wot-design-uni 快速起手demo wot

📦插件列表

插件名 描述 参数名
vite-plugin-uni-components 按需自动引入组件 import
vite-plugin-uni-pages 提供基于文件系统的路由 pages
vite-plugin-uni-layouts 提供类 nuxt 的 layouts 系统 layouts
vite-plugin-uni-manifest 自动生成 manifest.json 文件 manifest
vite-plugin-uni-platform 基于文件名 (.<h5|mp-weixin|app>.) 的按平台编译插件 filePlatform
vite-plugin-uni-platform-modifier 为属性、指令提供平台修饰符并按需编译 platformModifier
vite-plugin-uni-middleware 使用路由中间件 middleware

📦模块列表

模块名 描述 参数名
pinia 符合直觉的 Vue.js 状态管理库 pinia
unocss 即时按需的原子级 CSS 引擎 unocss
uni-network 为 uni-app 打造的基于 Promise 的网络请求库 uniNetwork
uni-use uni-app 组合式工具集 uniUse
uni-promises 为 uni-app 提供的 Promise 包装器 uniPromises

📦组件列表

组件名 描述 参数名
Uni UI UniApp官方组件库 uni
wot-design-uni 高颜值、轻量化的uni-app组件库 wot
nutui-uniapp 京东风格的轻量级移动端组件库 nut
uv-ui 多平台快速开发的UI框架 uv
Ano UI 轻量级、漂亮、快速的 UnoCSS 组件库 ano

🛠️ 环境要求

Vite 需要 Node.js 版本 18+ 或 20+

🤝 参与贡献

🌸 感谢

项目灵感及部分代码来自 create-vue

📄 License

MIT LICENSE

🙇🏻‍♂️赞助

sponsors