108 lines
5.5 KiB
Markdown
108 lines
5.5 KiB
Markdown
<p align="center">
|
||
<a href="https://github.com/feige996/unibest">
|
||
<img width="160" src="./src/static/logo.svg">
|
||
</a>
|
||
</p>
|
||
|
||
<h1 align="center">
|
||
<a href="https://github.com/feige996/unibest" target="_blank">unibest - 最好的 uniapp 开发框架</a>
|
||
</h1>
|
||
|
||
<div align="center">
|
||
旧仓库 codercup 进不去了，star 也拿不回来，这里也展示一下那个地址的 star.
|
||
|
||
[](https://github.com/codercup/unibest)
|
||
[](https://github.com/codercup/unibest)
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
[](https://github.com/feige996/unibest)
|
||
[](https://github.com/feige996/unibest)
|
||
[](https://gitee.com/feige996/unibest/stargazers)
|
||
[](https://gitee.com/feige996/unibest/members)
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
`unibest` —— 最好的 `uniapp` 开发模板，由 `uniapp` + `Vue3` + `Ts` + `Vite5` + `UnoCss` + `wot-ui` + `z-paging` 构成，使用了最新的前端技术栈，无需依靠 `HBuilderX`，通过命令行方式运行 `web`、`小程序` 和 `App`（编辑器推荐 `VSCode`，可选 `webstorm`）。
|
||
|
||
`unibest` 内置了 `约定式路由`、`layout布局`、`请求封装`、`请求拦截`、`登录拦截`、`UnoCSS`、`i18n多语言` 等基础功能，提供了 `代码提示`、`自动格式化`、`统一配置`、`代码片段` 等辅助功能，让你编写 `uniapp` 拥有 `best` 体验 （ `unibest 的由来`）。
|
||
|
||
|
||
|
||
<p align="center">
|
||
<a href="https://unibest.tech/" target="_blank">📖 文档地址(new)</a>
|
||
<span style="margin:0 10px;">|</span>
|
||
<a href="https://feige996.github.io/hello-unibest/" target="_blank">📱 DEMO 地址</a>
|
||
</p>
|
||
|
||
---
|
||
|
||
注意旧的地址 [codercup](https://github.com/codercup/unibest) 我进不去了，使用新的 [feige996](https://github.com/feige996/unibest)。PR和 issue 也请使用新地址，否则无法合并。
|
||
|
||
## 平台兼容性
|
||
|
||
| H5 | IOS | 安卓 | 微信小程序 | 字节小程序 | 快手小程序 | 支付宝小程序 | 钉钉小程序 | 百度小程序 |
|
||
| --- | --- | ---- | ---------- | ---------- | ---------- | ------------ | ---------- | ---------- |
|
||
| √ | √ | √ | √ | √ | √ | √ | √ | √ |
|
||
|
||
注意每种 `UI框架` 支持的平台有所不同，详情请看各 `UI框架` 的官网，也可以看 `unibest` 文档。
|
||
|
||
## ⚙️ 环境
|
||
|
||
- node>=18
|
||
- pnpm>=8
|
||
- Vue Official>=2.1.10
|
||
- TypeScript>=5.0
|
||
|
||
## 📂 快速开始
|
||
|
||
执行 `pnpm create unibest` 创建项目
|
||
执行 `pnpm i` 安装依赖
|
||
执行 `pnpm dev` 运行 `H5`
|
||
执行 `pnpm dev:mp` 运行 `微信小程序`
|
||
|
||
## 📦 运行（支持热更新）
|
||
|
||
- web平台： `pnpm dev:h5`, 然后打开 [http://localhost:9000/](http://localhost:9000/)。
|
||
- weixin平台：`pnpm dev:mp-weixin` 然后打开微信开发者工具，导入本地文件夹，选择本项目的`dist/dev/mp-weixin` 文件。
|
||
- APP平台：`pnpm dev:app`, 然后打开 `HBuilderX`，导入刚刚生成的`dist/dev/app` 文件夹，选择运行到模拟器(开发时优先使用)，或者运行的安卓/ios基座。
|
||
|
||
## 🔗 发布
|
||
|
||
- web平台： `pnpm build:h5`，打包后的文件在 `dist/build/h5`，可以放到web服务器，如nginx运行。如果最终不是放在根目录，可以在 `manifest.config.ts` 文件的 `h5.router.base` 属性进行修改。
|
||
- weixin平台：`pnpm build:mp-weixin`, 打包后的文件在 `dist/build/mp-weixin`，然后通过微信开发者工具导入，并点击右上角的“上传”按钮进行上传。
|
||
- APP平台：`pnpm build:app`, 然后打开 `HBuilderX`，导入刚刚生成的`dist/build/app` 文件夹，选择发行 - APP云打包。
|
||
|
||
## 🤔 如何贡献
|
||
|
||
非常欢迎您的加入！提一个 [Issue](https://github.com/feige996/unibest/issues) 或者提交一个 [Pull Request](https://github.com/feige996/unibest/pulls)
|
||
|
||
**Pull Request:**
|
||
|
||
- 1. `Fork` 代码到自己的项目下，不要直接在仓库下建分支
|
||
- 2. 请选择 `base` 分支，进行 `PR`
|
||
- 3. 提交 `PR` 前请 `rebase`，确保 `commit` 记录的整洁
|
||
- 4. 注意 `commit` 信息规范，要以 `type: 描述信息` 的形式填写，注意 `type` 得是下面规范之中的一个
|
||
- 5. 示例 `commit 信息`：`fix: 修复样式问题`
|
||
- 6. 可以使用项目中的 `pnpm cz` 进行 `commit` 提交
|
||
- 7. 等待作者 `review` 通过后，即可合并
|
||
|
||
## 📄 License
|
||
|
||
[MIT](https://opensource.org/license/mit/)
|
||
|
||
Copyright (c) 2025 菲鸽
|
||
|
||
## 捐赠
|
||
|
||
<p align='center'>
|
||
<img alt="special sponsor appwrite" src="https://oss.laf.run/ukw0y1-site/pay/wepay.png" height="330" style="display:inline-block; height:330px;">
|
||
<img alt="special sponsor appwrite" src="https://oss.laf.run/ukw0y1-site/pay/alipay.jpg" height="330" style="display:inline-block; height:330px; margin-left:10px;">
|
||
</p>
|