# vue3-template

**Repository Path**: bidiao/vue3-template

## Basic Information

- **Project Name**: vue3-template
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-18
- **Last Updated**: 2025-11-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目名称

> 项目线上链接 <https://example.com/>

## 项目介绍

<!-- 项目简介及业务范围介绍 -->

## 人员

- PD：
- 服务端：
- 视觉&交互：
- 前端：
- 测试：

## 相关资料

- PRD 地址:
- 视觉稿地址:
- 数据接口约定:
- 其他资料:

## 项目开发

### 目录说明

- `public` 静态资源目录
- `configs` 开发及编译选项配置目录
- `docs` 一些注意事项及规范说明
- `index.html` 模版文件（请勿移动，使用public的文件资源时，请记住直接使用`/`，不会影响打包）
- `src` 项目开发的文件放此处
  - `assets` 开发过程中的资源文件目录
  - `components` 全局组件目录
  - `framework` 提供到项目专用的框架目录
  - `router` 路由配置目录
  - `stores` 项目存储器目录
  - `styles` 全局样式目录
  - `utils` 工具函数目录
  - `views` 页面目录

### 开发环境依赖

- `nodejs`: 尽可能使用新的版本

### 开发调试

- `.env` 代码全局预编译参数
- `$ npm run dev`

### 打包

- `.env.production` 继承 `.env` 的预编译参数，并可覆盖修改参数
- `$ npm run build`

执行 build 命令前会自动执行 eslint 语法检查，如果有错误，会中止 build

### 关于 proxy（接口代理 ）

- 修改 .env 中的 VUE_APP_API

### 开发规范

- 禁止关闭 eslint 校验，或删除已有的规则
- 最终上线的代码禁止出现任何 eslint 报错，包括 warning
- 请不要在 src/components 目录中添加非全局组件，比如 仅仅是某一个页面使用的业务模块
- 禁止将本地调试的 token、密码等放到代码中发布到线上（注释掉也不行），如果本地调试需要 mock，请走 mock 方案
- 禁止在代码中直接使用 fetch 或第三方数据请求库，所有数据请求必须走 services/index 方法，新增方法参照现有方案增加中间件
- 禁止跳过或私自修改 pre commit hook

### commit 规范

- `git commit` 会触发 husky hook，会执行 `npm run lint` 校验代码，请务必保证代码的正确性
- commit 信息必须按照规范: `type(scope): message` 来提交：例如：`feat(order): 增加订单详情`

以下是可用的 type:

- feat: 新功能，升级 y 位
- fix: 修复问题
- docs: 修改文档
- style: 修改代码格式
- refactor: 重构代码, 不影响功能
- perf: 提升性能
- test: 增加/修改测试用例
- break: 破坏性变更，升级 x 位
- chore: 构建过程或辅助工具的变动

## iconfont 配置地址

<!-- 请在 iconfont.cn 中新建项目 -->