# uniapp-template

**Repository Path**: hts123/uniapp-template

## Basic Information

- **Project Name**: uniapp-template
- **Description**: uniapp-template
- **Primary Language**: Unknown
- **License**: ISC
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-12-20
- **Last Updated**: 2026-03-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目说明

基于 UniApp + Vue3 开发的多端应用，支持小程序、H5 等多平台部署。

## 一、项目结构

```text
receiveHelper/
├── apis/                     # API 接口层 - 统一管理所有后端接口
│   ├── common.js             # 公共接口
│   ├── login.js              # 登录相关接口
│   ├── staff/                # 员工管理接口
│   └── subThirdParty/        # 第三方业务接口
├── common/                   # 公共功能模块
│   ├── config/               # 全局配置
│   ├── hooks/                # 组合式函数（Hooks）
│   ├── libraries/            # 库封装
│   ├── mixins/               # 混入
│   ├── router/               # 路由配置
│   ├── service/              # 请求服务封装
│   └── util/                 # 工具函数
├── components/               # 通用组件库
│   ├── leven-button/         # 自定义按钮组件
│   └── tc/                   # 业务组件集合
├── core/                     # 核心功能模块（重点）
│   ├── login/                # 登录认证模块
│   │   ├── data/             # 静态数据和常量配置
│   │   │   └── login.data.js # 登录相关配置数据
│   │   └── login.js          # 登录方法集合
│   └── staff/                # 员工管理模块（建议扩展）
├── pages/                    # 主包页面（仅 TabBar 页面）
│   ├── index/                # 首页
│   ├── list/                 # 列表页
│   └── login/                # 登录页
├── subPackages/              # 分包页面
│   ├── libraries/            # 库管理分包
│   └── recorder/             # 记录器功能
├── static/                   # 静态资源
│   ├── css/                  # 样式文件
│   ├── images/               # 图片资源
│   └── logo.png              # 应用图标
├── uni_modules/              # uni-app 扩展模块
├── js_sdk/                   # 第三方 JS SDK
└── unpackage/                # 编译输出目录
```

## 二、开发规范

### 2.1 分包配置规范

> **重要**：若应用需要打包到小程序中，必须进行分包处理。

**分包原则：**

- ✅ 主包仅保留 TabBar / 登录 页面（放在 `pages/` 目录）
- ✅ 其他所有页面均放入分包中（放在 `subPackages/` 目录）
- ✅ 按功能模块划分子目录，例如：
    - `subPackages/libraries/` - 库管理相关功能
    - `subPackages/business/` - 业务功能模块

**分页文件配置示例（pages.json）：**

```json
{
  "pages": [
    {
      "path": "pages/index/index",
      "style": {
        "navigationBarTitleText": "首页"
      }
    }
  ],
  "subPackages": [
    {
      "root": "subPackages/libraries",
      "pages": [
        {
          "path": "index/index",
          "style": {
            "navigationBarTitleText": "库管理"
          }
        }
      ]
    }
  ]
}
```

### 2.2 Core 目录规范

`core` 目录是项目的核心业务逻辑封装层，存放小程序的常用功能封装和数据。

#### 文件命名规范

| 文件类型 | 命名格式 | 示例 |
| --- | --- | --- |
| 数据配置文件 | `{模块名}.data.js` | `login.data.js` |
| 功能文件 | `{功能名}.js` | `login.js` |

#### 编码规范

- **常量命名**
    - 推荐使用全大写 + 下划线风格，例如：`LOGIN_TYPE_QR`
    - 业务常量统一放在 `core/{module}/data/` 或模块级 `constants.js`

#### 注意事项

- ✅ 所有静态变量和数据配置统一存放在 `data/` 目录下
- ✅ 每个核心功能模块独立成目录，保持清晰的模块边界
- ✅ 公共工具函数放在 `common/utils/`
- ✅ 异步函数必须返回统一的响应格式（`responseSuccess` / `responseError`）
- ⚠️ 避免在代码中直接硬编码常量，应提取到 `data/` 或 `constants.js`
---

## 三、技术栈

- **框架**：UniApp + Vue 3
- **样式**：SCSS + UnoCSS
- **UI 组件**：uv-ui
- **请求库**：luch-request
- **多端支持**：小程序、H5

## 四、快速开始

### 安装依赖

```bash
yarn install
```

### 启动开发服务器

```bash
yarn dev
```

## 五、常见问题

### Q: 如何添加新的分包？

A: 在 `subPackages/` 目录下创建新模块文件夹，并在 `pages.json` 中配置分包信息。

### Q: 如何扩展 core 模块？

A: 遵循 `core/{module}/` 目录结构规范，创建对应的 `data/` 子目录。

---

**最后更新**：2026-03-23