unibest/README.md

73 lines
3.6 KiB
Markdown
Raw Normal View History

2024-01-23 19:47:31 +08:00
<p align="center">
<a href="https://github.com/codercup/unibest">
2024-01-31 12:34:31 +08:00
<img width="160" src="./src/static/logo.svg">
2024-01-23 19:47:31 +08:00
</a>
</p>
2024-01-20 14:45:33 +08:00
2024-01-23 19:47:31 +08:00
<h1 align="center">
2024-05-26 09:51:39 +08:00
<a href="https://github.com/codercup/unibest" target="_blank">unibest - 最好的 uniapp 开发框架</a>
2024-01-23 19:47:31 +08:00
</h1>
2024-01-22 14:21:17 +08:00
2024-01-23 19:47:31 +08:00
<div align="center">
2024-01-23 10:42:55 +08:00
2024-01-23 16:12:07 +08:00
[![GitHub Repo stars](https://img.shields.io/github/stars/codercup/unibest?style=flat&logo=github)](https://github.com/codercup/unibest)
2024-02-24 17:39:50 +08:00
[![GitHub forks](https://img.shields.io/github/forks/codercup/unibest?style=flat&logo=github)](https://github.com/codercup/unibest)
2024-03-28 09:53:18 +08:00
[![star](https://gitee.com/codercup/unibest/badge/star.svg?theme=dark)](https://gitee.com/codercup/unibest/stargazers)
2024-01-24 19:29:52 +08:00
[![fork](https://gitee.com/codercup/unibest/badge/fork.svg?theme=dark)](https://gitee.com/codercup/unibest/members)
2024-03-01 09:55:22 +08:00
![node version](https://img.shields.io/badge/node-%3E%3D18-green)
2024-01-24 19:29:52 +08:00
![pnpm version](https://img.shields.io/badge/pnpm-%3E%3D7.30-green)
![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/codercup/unibest)
2024-02-23 08:42:51 +08:00
![GitHub License](https://img.shields.io/github/license/codercup/unibest)
2024-01-23 19:47:31 +08:00
</div>
2024-01-23 10:42:55 +08:00
2024-05-26 09:51:39 +08:00
`unibest` —— 最好的 `uniapp` 开发框架,由 `uniapp` + `Vue3` + `Ts` + `Vite5` + `UnoCss` + `wot-ui` + `z-paging` 构成,使用了最新的前端技术栈,无需依靠 `HBuilderX`,通过命令行方式运行 `web``小程序``App`(编辑器推荐 `VSCode`,可选 `webstorm`)。
2024-03-28 09:53:18 +08:00
`unibest` 内置了 `约定式路由``layout布局``请求封装``请求拦截``登录拦截``UnoCSS``i18n多语言` 等基础功能,提供了 `代码提示``自动格式化``统一配置``代码片段` 等辅助功能,让你编写 `uniapp` 拥有 `best` 体验 `unibest 的由来`)。
2024-01-23 10:42:55 +08:00
2024-05-31 14:49:56 +08:00
![](https://raw.githubusercontent.com/andreasbm/readme/master/screenshots/lines/rainbow.png)
2024-01-23 10:42:55 +08:00
2024-01-28 19:24:10 +08:00
<p align="center">
2024-05-12 19:53:34 +08:00
<a href="https://codercup.github.io/unibest-docs/" target="_blank">📖 文档地址</a>
2024-05-23 10:38:19 +08:00
<span style="margin:0 10px;">|</span>
<a href="https://codercup.github.io/hello-unibest/" target="_blank">📱 DEMO 地址</a>
2024-01-28 19:24:10 +08:00
</p>
2024-01-23 10:42:55 +08:00
## ⚙️ 环境
2024-01-03 10:52:59 +08:00
2024-03-01 09:46:41 +08:00
- node>=18
2024-01-24 19:29:52 +08:00
- pnpm>=7.30
2023-12-23 14:18:42 +08:00
2024-05-12 19:53:34 +08:00
## &#x1F4C2; 快速开始
执行 `pnpm create unibest` 创建项目
2024-01-31 20:15:44 +08:00
执行 `pnpm i` 安装依赖
2024-05-12 19:53:34 +08:00
执行 `pnpm dev` 运行 `H5`
2024-01-24 14:35:10 +08:00
## 📦 运行(支持热更新)
2023-12-23 14:18:42 +08:00
2024-01-03 10:52:59 +08:00
- web平台 `pnpm dev:h5`, 然后打开 [http://localhost:9000/](http://localhost:9000/)。
- weixin平台`pnpm dev:mp-weixin` 然后打开微信开发者工具,导入本地文件夹,选择本项目的`dist/dev/mp-weixin` 文件。
2024-01-23 10:42:55 +08:00
- APP平台`pnpm dev:app`, 然后打开 `HBuilderX`,导入刚刚生成的`dist/dev/app` 文件夹,选择运行到模拟器(开发时优先使用),或者运行的安卓/ios基座。
2023-12-23 14:18:42 +08:00
2024-01-23 10:42:55 +08:00
## 🔗 发布
2023-12-23 14:18:42 +08:00
2024-01-29 10:58:37 +08:00
- web平台 `pnpm build:h5`,打包后的文件在 `dist/build/h5`可以放到web服务器如nginx运行。如果最终不是放在根目录可以在 `manifest.config.ts` 文件的 `h5.router.base` 属性进行修改。
- weixin平台`pnpm build:mp-weixin`, 打包后的文件在 `dist/build/mp-weixin`,然后通过微信开发者工具导入,并点击右上角的“上传”按钮进行上传。
2024-01-19 17:53:21 +08:00
- APP平台`pnpm build:app`, 然后打开 `HBuilderX`,导入刚刚生成的`dist/build/app` 文件夹,选择发行 - APP云打包。
2024-01-29 10:52:32 +08:00
## 📄 License
2024-01-22 09:46:38 +08:00
2024-01-23 10:42:55 +08:00
[MIT](https://opensource.org/license/mit/)
2024-01-22 09:46:38 +08:00
2024-01-23 10:42:55 +08:00
Copyright (c) 2024 菲鸽
2024-05-31 14:49:56 +08:00
## 捐赠
<p align='center'>
<img alt="special sponsor appwrite" src="./screenshots/pay-1.png" height="330" style="display:inline-block; height:330px;">
<img alt="special sponsor appwrite" src="./screenshots/pay-2.png" height="330" style="display:inline-block; height:330px; margin-left:10px;">
</p>