修改readme

This commit is contained in:
D 2023-08-13 00:53:30 +08:00
parent 953ef9ad41
commit 0cfcebb7f4

View File

@ -1,6 +1,7 @@
# geek-uniapp-vue3-uview-plus-ucharts # geek-uniapp-vue3-uview-plus-ucharts
# 介绍 # 介绍
* 本框架基于RuoYi-App框架二次修改使用Uniapp+Vue3。 * 本框架基于RuoYi-App框架二次修改使用Uniapp+Vue3。
* 同时支持js或者ts。 * 同时支持js或者ts。
* 同时支持css、scss、less * 同时支持css、scss、less
@ -13,6 +14,8 @@
一下三种方式均可,感觉速度 pnpm > yarn > cnpm > npm 一下三种方式均可,感觉速度 pnpm > yarn > cnpm > npm
***Vue3/Vite版要求 node 版本^14.18.0 || >=16.0.0***
```shell ```shell
npm install npm install
cnpm install cnpm install
@ -21,7 +24,9 @@ pnpm install
``` ```
# 启动 # 启动
详见package.json的“scripts”以下是案例 详见package.json的“scripts”以下是案例
```shell ```shell
:: 微信小程序编译运行 :: 微信小程序编译运行
npm run dev:mp-weixin npm run dev:mp-weixin
@ -30,23 +35,33 @@ npm run dev:mp-weixin
# 作者建议 # 作者建议
### 对于选项式 ### 对于选项式
```js ```js
this.$tab // 建议使用this.$tab进行页面跳转理由便于在跳转前处理其他事务 this.$tab // 建议使用this.$tab进行页面跳转理由便于在跳转前处理其他事务
this.$auth // 建议使用this.$auth进行鉴权操作 this.$auth // 建议使用this.$auth进行鉴权操作
this.$modal // 建议使用this.$modal打开弹窗理由便于以后想要使用自定义弹窗 this.$modal // 建议使用this.$modal打开弹窗理由便于以后想要使用自定义弹窗
``` ```
### 对于组合式 ### 对于组合式
```js ```js
import tab from '@/plugins/tab' // 建议使用tab进行页面跳转理由便于在跳转前处理其他事务 import tab from '@/plugins/tab' // 建议使用tab进行页面跳转理由便于在跳转前处理其他事务
import auth from '@/plugins/auth' // 建议使用auth进行鉴权操作 import auth from '@/plugins/auth' // 建议使用auth进行鉴权操作
import modal from '@/plugins/modal' // 建议使用modal打开弹窗理由便于以后想要使用自定义弹窗 import modal from '@/plugins/modal' // 建议使用modal打开弹窗理由便于以后想要使用自定义弹窗
``` ```
### 对于ucharts ### 对于ucharts
建议即便暂时不使用图表也不要删除它,以后可能会用到。 建议即便暂时不使用图表也不要删除它,以后可能会用到。
# 压缩内存 # 压缩内存
(主包最低809kb左右) (主包最低809kb左右)
### 去除模板 ### 去除模板
占用主包582kb左右 占用主包582kb左右
1. 删除pages_template、pages_qiun两个文件夹 1. 删除pages_template、pages_qiun两个文件夹
2. 删除pages.json中subPackages的root值为“pages_qiun/pages”、“pages_template/pages”的两个配置 2. 删除pages.json中subPackages的root值为“pages_qiun/pages”、“pages_template/pages”的两个配置
3. 删除pages/template.config.js和pages/template.vue 3. 删除pages/template.config.js和pages/template.vue
@ -55,24 +70,31 @@ import modal from '@/plugins/modal' // 建议使用modal打开弹窗理由
6. 删除plugins中的config.js和common.js并在plugins/index.js中删除相关配置 6. 删除plugins中的config.js和common.js并在plugins/index.js中删除相关配置
### 删除uchart ### 删除uchart
占用主包175kb左右不建议删除以防以后会用 占用主包175kb左右不建议删除以防以后会用
1. 删除components/qiun-data-charts文件夹 1. 删除components/qiun-data-charts文件夹
2. 删除pages.json中的easycom下的custom中的"qiun-(.*)"的那一行 2. 删除pages.json中的easycom下的custom中的"qiun-(.*)"的那一行
3. 删除pages/index中使用 “qiun-data-charts” 的部分 3. 删除pages/index中使用 “qiun-data-charts” 的部分
### 删除uview ### 删除uview
(按需引入,没必要删除) (按需引入,没必要删除)
1. main.js或者main.ts中删除 1. main.js或者main.ts中删除
```js ```js
import uviewPlus from 'uview-plus' import uviewPlus from 'uview-plus'
// ...... // ......
app.use(uviewPlus) app.use(uviewPlus)
``` ```
2. uni.scss中删除 @import 'uview-plus/theme.scss'; 2. uni.scss中删除 @import 'uview-plus/theme.scss';
3. App.vue中删除 @import '@/static/scss/index.scss'; 3. App.vue中删除 @import '@/static/scss/index.scss';
4. package.json中删除 "clipboard": "^2.0.11","dayjs": "^1.11.9","uview-plus": "^3.1.36", 4. package.json中删除 "clipboard": "^2.0.11","dayjs": "^1.11.9","uview-plus": "^3.1.36",
# 附录 # 附录
[Vue3官网](https://cn.vuejs.org/) [Vue3官网](https://cn.vuejs.org/)
[uniapp官网](https://uniapp.dcloud.net.cn/) [uniapp官网](https://uniapp.dcloud.net.cn/)
[uView-plus官网](https://uiadmin.net/uview-plus/) [uView-plus官网](https://uiadmin.net/uview-plus/)