unibest/README.md

91 lines
3.6 KiB
Markdown
Raw Normal View History

2024-01-20 14:45:33 +08:00
# unifly
(原名 vue3-uniapp-template
由 Vue3 & Ts & Vite4 & uni-app & UnoCss & UniUI 驱动的跨端快速启动模板VS Code + Prettier +ESLint + husky + lint-staged + commitlint
2023-12-23 14:18:42 +08:00
## 特性
- ⚡️ [Vue 3](https://github.com/vuejs/core), [Vite](https://github.com/vitejs/vite), [pnpm](https://pnpm.io/), [esbuild](https://github.com/evanw/esbuild) - 就是快!
- 📦 [组件自动化加载](./src/components)
2024-01-03 10:52:59 +08:00
- 📑 pinia+适用于多端的持久化方案
2023-12-23 14:18:42 +08:00
- 🎨 [UnoCSS](https://unocss.dev/) - 高性能且极具灵活性的即时原子化 CSS 引擎
2023-12-23 14:18:42 +08:00
- 😃 [UnoCSS Icons](https://unocss.dev/presets/icons), [海量图标-https://icones.js.org/](https://icones.js.org/)
2023-12-23 14:18:42 +08:00
- 🔥 使用 [新的 `<script setup>` 语法](https://github.com/vuejs/rfcs/pull/227)
- 📥 [API 自动加载](https://github.com/antfu/unplugin-auto-import) - 直接使用 Composition API 无需引入
- 🦾 [TypeScript](https://www.typescriptlang.org/) & [ESLint](https://eslint.org/) & [stylelint](https://stylelint.io/) - 保证代码质量
2024-01-03 10:52:59 +08:00
- 🗂 [husky](https://typicode.github.io/husky/) & [lint-staged](https://github.com/lint-staged/lint-staged) + [commitlint](https://commitlint.js.org/) - 保证代码提交质量
- 🗂 ES6 import 顺序自动排序css 属性自动排序,增强编码一致性
- 🗂 使用请求拦截器,封装好您的请求
- 🗂 图片自动压缩再也不用去tinyPng等网站压缩图片了
- 🗂 多环境配置分开,想则怎么配置就怎么配置
## 业务功能 TODO LIST
2024-01-15 11:22:49 +08:00
- [x] 页面下拉刷新(全局+局部)
- [x] 页面上拉加载
2024-01-03 20:27:06 +08:00
- [x] 导航栏返回or去首页
2024-01-05 11:19:43 +08:00
- [x] 导航栏渐变(微信+h5)
2024-01-03 20:27:06 +08:00
- [x] 自定义导航栏顶部机型适配
- [x] 微信小程序分享(好友+朋友圈)
2024-01-09 19:23:57 +08:00
- [ ] 微信登录
2024-01-15 11:22:49 +08:00
- [ ] 微信一键登录(基于手机号)
2024-01-09 19:23:57 +08:00
- [ ] 仿BOSS直聘-个人中心
- [ ] 仿华为商城-个人中心
2024-01-09 10:30:15 +08:00
- [ ] 页面悬浮球(floating bubble)
- [ ] 多tab列表功能
2024-01-15 11:22:49 +08:00
- [ ] 瀑布流
- [ ] 头像上传
- [ ] 图片剪辑
2024-01-10 20:47:19 +08:00
- [x] 抽奖-九宫格抽奖
2024-01-15 11:22:49 +08:00
- [ ] 抽奖-大转盘抽奖
2024-01-09 19:23:57 +08:00
- [ ] 仿网易云音乐APP独立项目
2024-01-03 10:52:59 +08:00
## 环境
- pnpm>=8.12
2024-01-09 09:56:52 +08:00
- node>=18
2023-12-23 14:18:42 +08:00
2024-01-20 14:45:33 +08:00
## 仓库地址
2024-01-20 14:45:33 +08:00
- github
2024-01-20 14:45:33 +08:00
- ~~`https://github.com/fly-vue3-templates/vue3-uniapp-template`~~ (旧地址)
2024-01-20 14:45:33 +08:00
- `https://github.com/codercup/unifly` (新地址)
2024-01-20 14:45:33 +08:00
- gitee
2024-01-20 14:45:33 +08:00
- ~~`https://gitee.com/fly-vue3-templates/vue3-uniapp-template.git fly`~~ (旧地址)
2024-01-20 14:45:33 +08:00
- `https://gitee.com/codercup/unifly` (新地址)
2024-01-20 14:45:33 +08:00
> 旧地址也可以访问,会自动跳转到新地址
2024-01-03 10:52:59 +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-19 17:53:21 +08:00
- APP平台`pnpm dev:app`, 然后打开 `HBuilderX`,导入刚刚生成的`dist/dev/app` 文件夹,选择运行到模拟器,或者运行的安卓/ios基座。
![app运行](./screenshots/app-dev.png)
2023-12-23 14:18:42 +08:00
2024-01-03 10:52:59 +08:00
## 发布
2023-12-23 14:18:42 +08:00
2024-01-03 10:52:59 +08:00
- web平台 `pnpm build:h5`,打包后的文件在 `dist/build/h5`可以放到web服务器如nginx运行。如果最终不是放在根目录可以在 `vite.config.ts``base` 属性进行配置。[vite官网](https://cn.vitejs.dev/config/shared-options.html#base)
- weixin平台`pnpm build:h5`, 打包后的文件在 `dist/build/mp-weixin`,然后通过微信开发者工具导入,并点击右上角的“上传”按钮进行上传。
2024-01-19 17:53:21 +08:00
- APP平台`pnpm build:app`, 然后打开 `HBuilderX`,导入刚刚生成的`dist/build/app` 文件夹,选择发行 - APP云打包。
2024-01-20 14:45:33 +08:00
![app发行](./screenshots/app-build.png)