# vite_app

**Repository Path**: raohuiyong/vite_app

## Basic Information

- **Project Name**: vite_app
- **Description**: 一个基于vue3+ts+vant4的H5模板
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-10-28
- **Last Updated**: 2025-07-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# App H5

### 开发规范

#### 目录的命名规范

- 目录名全部使用小写，`kebab-case`形式命名，如果需要有多个单词表达，使用中划线连接。如new-page、components。

#### 文件的命名规范

文件的命名规范按照不同情况进行命名

1. 如果该文件是单文件组件/类，采用`PascalCase`形式命名，方便导入和使用。如TDesignSelect.vue

2. 如果该文件是目录下的主文件，采用 index 名称命名，方便导入。如 index.ts, index.vue

3. 如果该文件是接口定义文件，采用`camelCase`形式命名，方便区分文件关联性。如 list.ts 和 listModel.ts

4. 如果该文件是资源/样式文件，采用`kebab-case`形式命名。如 list.css 和 list-model.css

#### 类及接口的命名规范

1. 采用`PascalCase`形式命名。

2. 接口命名以大写 I 开头，代表 interface。如IOption。

### 注意事项

**`使用 yarn 进行安装本项目`**

- node >= 18
- _**严格遵守项目提交规范（commitlint）**_
- 如果使用的是 Windows，则需要关闭行尾转换 `git config --global core.autocrlf input`

### 命令

- 启动本地开发环境（自带热启动）

```bash
# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# 启用本地mock，同时也会启用远程地址(mock接口都是以/mock开头的)
$ yarn dev:mock

# build for production
$ yarn build

# eslint检查
$ yarn lint

# eslint修复
$ yarn lint:fix

# stylelint检查
$ yarn stylelint

# stylelint修复
$ yarn stylelint:fix

# prettier检查
$ yarn format

# prettier修复
$ yarn format:fix

# 执行eslint修复、stylelint修复和prettier修复
$ yarn fix

# 启用 git hooks
$ yarn prepare

# 启提交代码，请使用此方式进行代码提交！请使用此方式进行代码提交！请使用此方式进行代码提交！
$ yarn commit
```