# uniapp-vue3-ts

**Repository Path**: fancyAix/uniapp-vue3-ts

## Basic Information

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

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2023-04-28
- **Last Updated**: 2023-07-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 简介

- **uni-app Vue3 Vite4 pinia2 TypeScript**

### 说明

- 框架完全基于 Vue3 SFC `<script setup>` 写法,不支持 Vue2;
- [代码规范 & 详细解释 husky、prettier、eslint、lint-staged 的作用和使用](https://blog.csdn.net/cookcyq__/article/details/125457031)

## 特性

- **最新技术栈**：使用 Vue3/Vite4/pinia ,TypeScript 等前端前沿技术开发;
- **Eslint/Prettier**: 规范代码格式,统一编码;

## 目录结构

```shell
.
├───📁 .husky
│   ├───📁
│   │   └───...
│   ├───📄 commit-msg
│   └───📄 pre-commit
├───📁 .vscode
│   └───📄 settings.json
├───📁 src
│   ├───📁 assets # 静态资源目录
│   ├───📁 components # 组件目录
│   ├───📁 enums # 枚举/常量，例如：cacheEnum.ts，以 Enum 结尾
│   ├───📁 pages # 页面
│   │   └───...
│   ├───📁 service # 接口相关
│   │   └───...
│   ├───📁 store # 状态管理模式(pinia)
│   ├───📁 static # 静态公共文件
│   │   └───...
│   ├───📁 types # 类型文件
│   ├───📁 utils # 工具类
│   │   └───...
│   ├───📄 App.vue
│   ├───📄 env.d.ts
│   ├───📄 main.ts
│   ├───📄 manifest.json
│   ├───📄 pages.json
│   ├───📄 shime-uni.d.ts
│   └───📄 uni.scss
├───📁 typings
│   └───📄 auto-imports.d.ts
├───📄 .editorconfig
├───📄 .env.development
├───📄 .env.production
├───📄 .env.test
├───📄 .eslintignore
├───📄 .eslintrc.js
├───📄 .gitignore
├───📄 .prettierignore
├───📄 .prettierrc.js
├───📄 README.md
├───📄 commitlint.config.js
├───📄 index.html
├───📄 package.json
├───📄 tsconfig.json
└───📄 vite.config.ts

```

## 安装使用

- 安装依赖

```bash
yarn
```

- 运行

```bash
# 其他端请查看 package.json script
yarn dev:h5
```

- 打包

```bash
# 其他端请查看 package.json script
yarn build:h5
```

### 提交类型

| 提交类型   | 标题         | 描述                                                                                  |
| ---------- | ------------ | ------------------------------------------------------------------------------------- |
| `feat`     | 特征         | 新功能、新特性                                                                        |
| `fix`      | Bug 修复     | bug 修复                                                                              |
| `docs`     | 文档         | 仅文档更改                                                                            |
| `style`    | 风格         | 不影响代码含义的更改（空格、格式、缺少分号等）                                        |
| `refactor` | 代码重构     | 重构，在不影响代码内部行为，功能下的代码修改                                          |
| `perf`     | 性能改进     | 更改代码，以提高性能                                                                  |
| `test`     | 测试         | 添加缺失的测试或纠正现有的测试                                                        |
| `build`    | 构建         | 影响构建系统或外部依赖项的更改（示例范围：gulp、broccoli、npm）                       |
| `ci`       | 持续集成     | 对我们的 CI 配置文件和脚本的更改（示例范围：Travis、Circle、BrowserStack、SauceLabs） |
| `chore`    | 其他文件修改 | 不修改 src 或测试文件的其他更改                                                       |
| `revert`   | 还原         | 恢复之前的提交                                                                        |
| `release`  | 发布新版本   | \-                                                                                    |