# chat-template

**Repository Path**: yshhhh/chat-template

## Basic Information

- **Project Name**: chat-template
- **Description**: 微信小程序模版
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-28
- **Last Updated**: 2024-03-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 小程序开发模版
```
微信小程序，采用里npm来安装依赖以及初始化构建，UI框架用来vant。
vant采用了按需加载，在上传之前需要先执行npm run cleanVant，
可直接在控制台中执行或者在微信开发者工具中设置自定义构建命令来执行,
如果遇到使用自定义构建命令报错参考下面的链接(一般用nvm装的node都有这个问题)；
若是不使用自定义构建命令请将project.private.config.json里的script删除,后续上传时手动执行命令
```
参考链接: https://developers.weixin.qq.com/community/develop/doc/000c8284bd43786f4c28cd34c5bc00.


## chat-template setup
#### 安装依赖
```
npm install
```
#### 微信开发者工具构建npm
```
工具-构建npm
```
### 项目运行
###### 开发环境
```
npm run dev
```
###### 生产环境
```
npm run pro
```

```
具体内容看package.json文件的命令，需要先执行package.json里的命令，
才能用微信开发者工具打开，因为环境变量和小程序的appId是动态注入的
```
### 目录说明 
  - components: 业务组件
  - config: 环境变量、初始化构建
  - filters: 过滤器
  - floorConfig: 楼层组件配置
  - http: 接口请求
  - miniprogram_npm: 第三方依赖
  - pages: 主包页面所在目录
  - runTime: 运行时的公共变量
  - utils: 工具类
  - .eslintrc.js: eslint
  - app.js: 小程序入口
  - app.json: 公共json入口
  - app.wxss: 公共样式入口
  - package.json: 项目配置信息
  - package-lock.json: 项目配置信息-锁版本
  - project.config.json: 小程序配置信息
  - project.private.config.json: 项目私有配置文件
  - README.md: 项目快速开始说明文件
  - sitemap.json: sitemap配置

### 开发规范 
```
1、页面创建 文件夹+文件 文件夹名称和文件名称保持一致
2、pages只允许放tab页面和需立即加载的页面；否则都需要放到分包里
3、wxml需要写上页面名称注释，模块复杂时，每块都要写上注释
4、js里定义的变量以及方法都需要写单行注释
5、调用两次以及两次以上的方法都需要封装起来放到utils里，并且需要写上备注
6、多次调用的常量都需要封装到utils里的baseConfig里
```