From a65bc2318eab58c636a1d60e1601a8ab421d7362 Mon Sep 17 00:00:00 2001
From: fonghehe <331002675@qq.com>
Date: Fri, 19 Aug 2022 18:41:36 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 479 +-----------------------------------------------------
1 file changed, 2 insertions(+), 477 deletions(-)
diff --git a/README.md b/README.md
index ed7ccc3..41fe6a9 100644
--- a/README.md
+++ b/README.md
@@ -1,485 +1,10 @@
# vue-h5-template
-基于 vue3 + vite + (nutui or varlet or vant) + sass + viewport 适配方案 +axios 封装,构建手机端模板脚手架
+基于 vue3 + vite + (nutui or varlet or vant) + sass + viewport 适配方案 + axios 封装,构建手机端模板脚手架
如果你不熟悉 vue3,想继续使用 vue2 开发的,可以[点这里](https://github.com/sunniejs/vue-h5-template/tree/vue2-h5-template)来获取 vue2-h5-template
-掘金: [移动端适配方案](https://juejin.cn/post/7018433228591595550)
-
-
-
-
-
-### Node 版本要求
-
-推荐你使用 NodeJs 14+的版本,毕竟技术日新月异。你可以使用 [nvm](https://github.com/nvm-sh/nvm) 或 [nvm-windows](https://github.com/coreybutler/nvm-windows) 在同一台电脑中管理多个 Node 版本。
-
-本示例 Node.js 14.19.0
-
-### 启动项目(强烈推荐使用 yarn)
-
-```bash
-
-git clone https://github.com/sunniejs/vue-h5-template.git
-
-cd vue-h5-template
-
-yarn install
-
-yarn dev
-```
-
-目录
-
-- [√ vite](#vite)
-- [√ 配置多环境变量](#env)
-- [√ viewport 适配方案](#viewport)
-- [√ 多 UI 组件库供选择](#ui)
-- [√ Pinia 状态管理](#Pinia)
-- [√ vue-router 4](#router)
-- [√ axios 封装及接口管理](#axios)
-- [√ vite.config.ts 基础配置](#base)
-- [√ alias](#alias)
-- [√ proxy 跨域](#proxy)
-- [√ Eslint+Pettier+stylelint 统一开发规范 ](#lint)
-
-### ✅ vite
-
-基于原生 ES 模块提供了丰富的内建功能,如速度快到惊人的模块热更新(HMR),使用 Rollup 打包你的代码,并且它是预配置的,可输出用于生产环境的高度优化过的静态资源。更多关于[vite](https://cn.vitejs.dev/guide/)
-
-模版集成了如下的 vite 插件
-
-- unplugin-auto-import(按需加载,自动引入)
-- unplugin-vue-components(按需加载,自动引入组件)
-- vite-plugin-compression(开启.gz 压缩)
-- vite-plugin-eruda(控制台,方便移动端调试)
-- vite-plugin-imagemin(图片压缩)
-- vite-plugin-mock(引入 mockjs,本地模拟接口)
-- vite-plugin-pages(动态生成路由)
-- vite-plugin-progress(构建显示进度条)
-- vite-plugin-restart(监听配置文件修改自动重启 Vite)
-- vite-plugin-style-import(按需引入样式文件)
-- vite-plugin-svg-icons(加载 SVG 文件,自动引入)
-
-### ✅ 配置多环境变量
-
-`package.json` 里的 `scripts` 配置 `dev` `dev:test` `dev:prod` ,通过 `--mode xxx` 来执行不同环境
-
-- 通过 `yarn dev` 启动本地环境参数 , 执行 `development`
-- 通过 `yarn dev:test` 启动测试环境参数 , 执行 `test`
-- 通过 `yarn dev:prod` 启动正式环境参数 , 执行 `prod`
-
-```javascript
-"scripts": {
- "dev": "vite",
- "dev:test": "vite --mode test",
- "dev:prod": "vite --mode production",
-}
-```
-
-[▲ 回顶部](#top)
-
-### ✅ viewport 适配方案
-
-不用担心,项目已经配置好了 `viewport` 适配,下面仅做介绍:
-
-- [cnjm-postcss-px-to-viewport](https://github.com/cnjm/postcss-px-to-viewport) 是一款 `postcss` 插件,用于将单位转化为 `vw`, 现在很多浏览器对`vw`的支持都很好,适配首选方案。
-
-##### PostCSS 配置
-
-下面提供了一份基本的 `postcss` 配置,可以在此配置的基础上根据项目需求进行修改
-
-```javascript
-// https://github.com/michael-ciniawsky/postcss-load-config
-module.exports = {
- plugins: {
- autoprefixer: { overrideBrowserslist: ['Android 4.1', 'iOS 7.1', 'Chrome > 31', 'ff > 31', 'ie >= 8'] },
- 'cnjm-postcss-px-to-viewport': {
- unitToConvert: 'px', // 要转化的单位
- viewportWidth: 750, // UI设计稿的宽度
- unitPrecision: 6, // 转换后的精度,即小数点位数
- propList: ['*'], // 指定转换的css属性的单位,*代表全部css属性的单位都进行转换
- viewportUnit: 'vw', // 指定需要转换成的视窗单位,默认vw
- fontViewportUnit: 'vw', // 指定字体需要转换成的视窗单位,默认vw
- minPixelValue: 1, // 默认值1,小于或等于1px则不进行转换
- mediaQuery: true, // 是否在媒体查询的css代码中也进行转换,默认false
- replace: true, // 是否转换后直接更换属性值
- include: [],
- exclude: [], // 设置忽略文件,用正则做目录名匹配
- customFun: ({ file }) => {
- // 这个自定义的方法是针对处理vant组件下的设计稿为375问题
- const designWidth = judgeComponent(file) ? 375 : 750;
- return designWidth;
- },
- },
-};
-```
-
-**新手必看,老鸟跳过**
-
-很多小伙伴会问我,适配的问题, 因为我们使用的是 Vant UI,所以必须根据 Vant UI 375 的设计规范走,一般我们的设计会将 UI 图上传到蓝湖,我们就可以需要的尺寸了。下面就大搞普及一下 rem。
-
-我们知道 `1rem` 等于 `html` 根元素设定的 `font-size` 的 `px` 值。Vant UI 设置 `rootValue: 37.5` , 你可以看到在 iPhone 6 下看到 ( `1rem 等于 37.5px` ):
-
-```html
-
-```
-
-切换不同的机型,根元素可能会有不同的 `font-size` 。当你写 css px 样式时,会被程序换算成 `rem` 达到适配。
-
-因为我们用了 Vant 的组件,需要按照 `rootValue: 37.5` 来写样式。
-
-举个例子:设计给了你一张 750px \* 1334px 图片,在 iPhone6 上铺满屏幕, 其他机型适配。
-
-- 当`rootValue: 75` , 样式 `width: 750px;height: 1334px;` 图片会撑满 iPhone6 屏幕,这个时候切换其他机型,图片也会跟着撑满。
-- 当`rootValue: 37.5` 的时候,样式 `width: 375px;height: 667px;` 图片会撑满 iPhone6 屏幕。
-
-也就是 iphone 6 下 375px 宽度写 CSS。其他的你就可以根据你设计图,去写对应的样式就可以了。
-
-当然,想要撑满屏幕你可以使用 100%,这里只是举例说明。
-
-```html
-
-
-
-```
-
-[▲ 回顶部](#top)
-
-### ✅ 多 UI 组件库供选择
-
-Vite 构建工具,使用 vite-plugin-style-import 和 unplugin-vue-components/vite 实现按需引入。
-
-#### 安装插件
-
-```bash
-yarn add vite-plugin-style-import -D
-yarn add unplugin-vue-components/vite -D
-```
-
-#### 使用组件库
-
-nutUI 没有按需加载的 resolvers,style 需要自己配置按需加载
-
-在 `config/vite/plugins/styleImport.ts` 设置
-
-```javascript
- // 按需加载样式文件
- ...
- createStyleImportPlugin({
- resolves: [NutuiResolve()],
- }),
- ...
-```
-
-项目在 `src/plugins/nutUI.ts` 下统一管理组件,用哪个引入哪个,无需在页面里重复引用
-
-```javascript
-// 按需全局引入nutUI组件
-import Vue from 'vue';
-import { Button, Cell, CellGroup } from '@nutui/nutui';
-export const nutUiComponents = [Button, Cell, CellGroup];
-
-// 在main.ts文件中引入
-nutUiComponents.forEach((item) => {
- app.use(item);
-});
-```
-
-vant 和 varlet 可以使用组件按需加载
-
-在`config/vite/plugins/component.ts`下
-
-```javascript
-import { VueUseComponentsResolver, VantResolver, VarletUIResolver } from 'unplugin-vue-components/resolvers';
-...
-resolvers: [VantResolver(), VarletUIResolver()],
-...
-```
-
-#### 不需要某个组件库
-
-nutUI 需删除`src/plugins/nutUI.ts`和`main.ts`文件下的引入
-
-vant 和 varlet 只需删除对应的 resolvers 即可
-
-删除后需全局搜索删除不需要的组件,避免报错
-
-[▲ 回顶部](#top)
-
-### ✅ Pinia 状态管理
-
-下一代 vuex,使用极其方便,ts 兼容好
-
-目录结构
-
-```bash
-├── store
-│ ├── modules
-│ │ └── user.js
-│ ├── index.js
-```
-
-使用
-
-```html
-
-```
-
-[▲ 回顶部](#top)
-
-### ✅ Vue-router
-
-本案例采用 `hash` 模式,开发者根据需求修改 `mode` `base`
-
-**注意**:如果你使用了 `history` 模式, `vue.config.js` 中的 `publicPath` 要做对应的**修改**
-
-前往:[vue.config.js 基础配置](#base)
-
-```javascript
-import Vue from 'vue';
-import { createRouter, createWebHistory, Router } from 'vue-router';
-
-Vue.use(Router);
-export const router = [
- {
- name: 'root',
- path: '/',
- redirect: '/home',
- component: () => import('@/layout/basic/index.vue'),
- },
-];
-
-const router: Router = createRouter({
- history: createWebHistory(),
- routes: routes,
-});
-
-export default router;
-```
-
-更多:[Vue Router](https://router.vuejs.org/zh/introduction.html)
-
-[▲ 回顶部](#top)
-
-### ✅ Axios 封装及接口管理
-
-`utils/request.js` 封装 axios , 开发者需要根据后台接口做修改。
-
-- `service.interceptors.request.use` 里可以设置请求头,比如设置 `token`
-- `config.hideloading` 是在 api 文件夹下的接口参数里设置,下文会讲
-- `service.interceptors.response.use` 里可以对接口返回数据处理,比如 401 删除本地信息,重新登录
-
-```javascript
-import axios from 'axios';
-import store from '@/store';
-import { Toast } from 'vant';
-// 根据环境不同引入不同api地址
-import { baseApi } from '@/config';
-// create an axios instance
-const service = axios.create({
- baseURL: baseApi, // url = base api url + request url
- withCredentials: true, // send cookies when cross-domain requests
- timeout: 5000, // request timeout
-});
-
-// request 拦截器 request interceptor
-service.interceptors.request.use(
- (config) => {
- // 不传递默认开启loading
- if (!config.hideloading) {
- // loading
- Toast.loading({
- forbidClick: true,
- });
- }
- if (store.getters.token) {
- config.headers['X-Token'] = '';
- }
- return config;
- },
- (error) => {
- // do something with request error
- console.log(error); // for debug
- return Promise.reject(error);
- },
-);
-// respone拦截器
-service.interceptors.response.use(
- (response) => {
- Toast.clear();
- const res = response.data;
- if (res.status && res.status !== 200) {
- // 登录超时,重新登录
- if (res.status === 401) {
- store.dispatch('FedLogOut').then(() => {
- location.reload();
- });
- }
- return Promise.reject(res || 'error');
- } else {
- return Promise.resolve(res);
- }
- },
- (error) => {
- Toast.clear();
- console.log('err' + error); // for debug
- return Promise.reject(error);
- },
-);
-export default service;
-```
-
-#### 接口管理
-
-在 `src/api` 文件夹下统一管理接口
-
-- 你可以建立多个模块对接接口, 比如 `home.js` 里是首页的接口这里讲解 `user.js`
-- `url` 接口地址,请求的时候会拼接上 `config` 下的 `baseApi`
-- `method` 请求方法
-- `data` 请求参数 `qs.stringify(params)` 是对数据系列化操作
-- `hideloading` 默认 `false`, 设置为 `true` 后,不显示 loading ui 交互中有些接口不需要让用户感知
-
-```javascript
-import qs from 'qs';
-// axios
-import request from '@/utils/request';
-//user api
-
-// 用户信息
-export function getUserInfo(params) {
- return request({
- url: '/user/userinfo',
- method: 'post',
- data: qs.stringify(params),
- hideloading: true, // 隐藏 loading 组件
- });
-}
-```
-
-#### 如何调用
-
-```javascript
-// 请求接口
-import { getUserInfo } from '@/api/user.js';
-
-const params = {
- user: 'sunnie',
-};
-getUserInfo(params)
- .then(() => {})
- .catch(() => {});
-```
-
-[▲ 回顶部](#top)
-
-### ✅ vite.config.ts 基础配置
-
-如果你的 `Vue Router` 模式是 hash
-
-```javascript
-publicPath: './',
-```
-
-如果你的 `Vue Router` 模式是 history 这里的 publicPath 和你的 `Vue Router` `base` **保持一致**
-
-```javascript
-publicPath: '/app/',
-```
-
-```javascript
-export default function ({ command }: ConfigEnv): UserConfigExport {
- const isProduction = command === 'build';
- return {
- server: {
- host: '0.0.0.0',
- },
- plugins: [
- vue(),
- vueJsx(),
- createStyleImportPlugin({
- resolves: [NutuiResolve()],
- }),
- eruda(),
- viteMockServe({
- mockPath: './src/mock',
- localEnabled: command === 'serve',
- logger: true,
- }),
- ],
- css: {
- preprocessorOptions: {
- scss: {
- // 配置 nutui 全局 scss 变量
- additionalData: `@import "@nutui/nutui/dist/styles/variables.scss";`,
- },
- },
- },
- };
-}
-```
-
-[▲ 回顶部](#top)
-
-### ✅ 配置 alias 别名
-
-```javascript
-resolve: {
- alias: [{
- find: 'vue-i18n',
- replacement: 'vue-i18n/dist/vue-i18n.cjs.js',
- },
- // /@/xxxx => src/xxxx
- {
- find: /\/@\//,
- replacement: pathResolve('src') + '/',
- },
- // /#/xxxx => types/xxxx
- {
- find: /\/#\//,
- replacement: pathResolve('types') + '/',
- },
- ],
-},
-```
-
-[▲ 回顶部](#top)
-
-### ✅ 配置 proxy 跨域
-
-```javascript
-server: {
- proxy: {
- '/api': {
- target: 'https://baidu.com',
- changeOrigin: true,
- rewrite: (path) => path.replace(/^\/api/, '')
- }
- }
-},
-```
-
-[▲ 回顶部](#top)
-
-### ✅ Eslint+Pettier+stylelint 统 ˜ 开发规范
-
-根目录下的`.eslintrc.js`、`.stylelint.config.js`、`.prettier.config.js`内置了 lint 规则,帮助你规范地开发代码,有助于提高团队的代码质量和协作性,可以根据团队的规则进行修改
+详细的文档请[点击](https://sunniejs.github.io/vue-h5-template/)查看
# 关于我