uni-helper / create-uni

🛠️快速创建uni-app项目

✨💚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 项目的轻量脚手架工具，它可以帮助你快速创建一个基于vite和vue3的uni-app项目，同时提供了一些模板供你选择。

🚤 快速使用

pnpm create uni --gui

pnpm create uni <项目名称> --ts -m pinia -m uniUse -u ano -e

npx @create-uni/info@latest
# --info  获取当前项目环境信息

参数说明

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

📦模板列表

模板名	描述	参数名
vitesse-uni-app	由 Vite & uni-app 驱动的跨端快速启动模板	vitesse
wot-demo	基于 vitesse-uni-app 的 wot-design-uni 快速起手demo	wot-demo
wot-starter-retail	基于Wot Design Uni的uni-app零售行业模板	wot-starter-retail
unisave	拥抱 web 开发，拯救 uniapp。适配所有(app、mp、web)平台	unisave

📦插件列表

插件名	描述	参数名
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
uni-ku-root	模拟虚拟根组件(支持SFC的App.vue)	root

📦模块列表

模块名	描述	参数名
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

🤝 参与贡献

• 提交新功能
• 解决issues
• 提交新模板/Plugin/module/UI

🛠️ 开发

• Node.js 版本 18+ 或 20+
• Rust 版本 1.64+
• 必须使用pnpm作为包管理工具
• Clone此仓库
• pnpm i安装依赖
• pnpm dev运行
• 可本地执行pnpm create-uni测试

🌸 感谢

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

📄 License

MIT LICENSE

🙇🏻‍♂️赞助