You've already forked template-MP
81 lines
2.4 KiB
Markdown
81 lines
2.4 KiB
Markdown
# 项目模板使用说明
|
|
|
|
这个模板是基于 UniApp + Vue3 + uView-Plus 的小程序项目模板，包含了一些常用的配置、组件和工具函数。
|
|
|
|
## 目录结构
|
|
|
|
```
|
|
├── api/ # 接口相关
|
|
│ ├── modules/ # 业务接口
|
|
│ └── request.js # 请求封装
|
|
├── common/ # 公共资源
|
|
│ ├── styles/ # 全局样式
|
|
│ │ ├── common.css # codefun原子类样式
|
|
│ │ └── base.scss # 全局样式变量
|
|
│ └── utils/ # 工具函数
|
|
│ └── tool.ts # 常用工具函数
|
|
├── components/ # 公共组件
|
|
├── uni_modules/ # uni-app 组件
|
|
│ └── z-paging/ # 分页组件库
|
|
├── lib/ # 第三方库
|
|
│ └── luch-request/ # luch-request 网络请求库
|
|
├── uview-plus/ # uView-Plus 组件库
|
|
├── mixins/ # Vue 混入
|
|
│ └── global.ts # 全局混入
|
|
├── store/ # 状态管理
|
|
│ └── index.ts # Vuex store
|
|
├── pages/ # 主包页面
|
|
├── subPages/ # 分包页面
|
|
├── App.vue # 应用入口
|
|
├── main.js # 主入口文件
|
|
├── pages.json # 页面配置
|
|
├── manifest.json # 应用配置
|
|
├── uni.scss # 全局样式变量
|
|
├── vite.config.js # Vite 编译配置
|
|
├── .nvmdrc # Node.js 版本要求
|
|
└── .env # 环境变量
|
|
```
|
|
|
|
## 使用方法
|
|
|
|
1. 将此模板目录复制到你的新项目目录中
|
|
2. 根据需要修改 package.json 中的项目名称和依赖
|
|
3. 使用 npm install 安装依赖
|
|
4. 根据需要修改 pages.json 中的页面配置
|
|
5. 开始开发你的新功能
|
|
|
|
## 包含的主要内容
|
|
|
|
### 必要开发依赖库
|
|
- **dotenv** - 环境变量注入
|
|
|
|
### 样式
|
|
|
|
- common.css: 全局基础样式
|
|
- base.scss: 常用的 SCSS 工具类
|
|
|
|
### 工具函数 (tool.js)
|
|
|
|
- alert: 文字轻提示
|
|
- loading/hideLoading: 显示/隐藏加载提示
|
|
- 页面跳转相关方法: navigateTo, redirectTo, reLaunch, switchTab, navigateBack
|
|
- 本地缓存操作: storage, removeStorage, getStorageInfo
|
|
- copy: 复制文本到剪贴板
|
|
- saveImageToPhotos: 保存图片到相册
|
|
- requestPayment: 微信支付
|
|
- upload: 文件上传
|
|
|
|
### 配置
|
|
|
|
- App.vue: 全局样式引入和基础配置
|
|
- main.js: Vue 应用初始化和全局插件引入
|
|
- pages.json: 页面路由和窗口配置
|
|
- uni.scss: 全局样式变量
|
|
|
|
## 注意事项
|
|
|
|
1. 根据实际项目需求调整依赖包
|
|
2. 根据项目需求修改或扩展工具函数
|
|
3. 组件可根据需要进行修改或替换
|
|
4. 样式文件可根据项目设计规范进行调整
|