# uctoo-uni-starter-vue2

**Repository Path**: UCT/uctoo-uni-starter

## Basic Information

- **Project Name**: uctoo-uni-starter-vue2
- **Description**: uctoo-uniapp基础脚手架，实现了大量商用项目常见功能，支持可视化页面搭建，云端一体应用快速开发基本项目模版。
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: v3
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2022-05-06
- **Last Updated**: 2025-08-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 小程序项目 README

## 项目概述

uctoo-uni-starter基础脚手架，实现了大量商用项目常见功能，支持可视化页面搭建，云端一体应用快速开发基本项目模版。

APP有很多通用的功能，比如登录注册、头像、设置、banner、... uctoo-uni-starter将这些功能都已经集成好。

项目采用了全栈模型同构的技术选型，使得前后端算法基本保持一致，为低代码、无代码、可视化代码生成等开发需求提供了更加规范化的架构风格和高效率的开发基础设施。

虽然近年来采用文档型数据库的云开发技术选型愈加流行，但实际业务应用中有大量需要融合或集成已有关系型数据库等ICT基础设施的需求，本项目在兼容原有技术选型的基础上又提供了与云开发一致的开发体验。

## 技术栈

- 前端框架：UniApp (Vue 3)
- 编程语言：TypeScript
- 构建工具：Vite
- 状态管理：Pinia + Pinia-ORM + pinia-orm/axios,示例了全栈模型同构的编程模型，弱化API通信的存在感，简化业务逻辑算法，支持采用关系型数据库的项目与采用文档型数据库的项目有相似的前端操作数据库编程模型。
- UI 组件：UniApp 内置组件
- 网络请求：Axios
- 开发工具：HBuilderX / VS Code

## 项目结构

```
miniapp/
├── .gitignore           # Git 忽略文件
├── index.html           # 入口 HTML 文件
├── package.json         # 项目依赖
├── shims-uni.d.ts       # TypeScript 类型声明
├── src/
│   ├── App.vue          # 应用入口组件
│   ├── main.ts          # 应用入口文件
│   ├── pages/
│   │   ├── login/       # 登录页面
│   │   ├── uctoo_user/  # 用户页面
│   │   ├── profile-edit/# 个人资料编辑页面
│   │   ├── orders/      # 订单页面
│   │   ├── favorites/   # 收藏页面
│   │   └── settings/    # 设置页面
│   ├── store/
│   │   └── models/      # Pinia-ORM 数据模型及API接口，可通过uctoo-backend项目batchCreateUniapp和batchCreateUniappFromDb命令行工具进行代码生成
│   ├── static/          # 静态资源
│   └── utils/           # 工具函数
├── tsconfig.json        # TypeScript 配置
├── tsconfig.node.json   # Node.js TypeScript 配置
└── vite.config.js       # Vite 配置
```

## 功能模块

1. **用户认证**
   - 登录/退出登录
   - 个人信息管理
   - 头像上传

2. **订单管理**
   - 订单创建
   - 订单列表
   - 订单详情

3. **个人中心**
   - 个人资料编辑
   - 我的收藏
   - 系统设置

## 安装与运行

### 环境要求
- Node.js >= 16.0.0
- pnpm >= 7.0.0
- HBuilderX 或 VS Code + UniApp 插件

### 安装步骤

1. 克隆项目
```bash
git clone <项目仓库地址>
cd uctoo-uni-starter
```

2. 安装依赖
```bash
pnpm install
```

### 运行步骤

1. 开发环境运行
```bash
# H5 端
pnpm run dev:h5

# 微信小程序端
# 需要在 HBuilderX 中运行或使用微信开发者工具
```

2. 构建生产环境
```bash
# H5 端
pnpm run build:h5

# 微信小程序端
# 需要在 HBuilderX 中构建
```

## 开发指南

### 目录规范
- 页面组件放在 `src/pages/` 目录下
- 公共组件放在 `src/components/` 目录下
- 工具函数放在 `src/utils/` 目录下
- 状态管理放在 `src/store/` 目录下
- 静态资源放在 `src/static/` 目录下

### 编码规范
- 使用 TypeScript 进行开发
- 组件命名采用 PascalCase 命名法
- 函数命名采用 camelCase 命名法
- 常量命名采用 UPPER_SNAKE_CASE 命名法
- 代码风格遵循项目中的 ESLint 和 Prettier 配置

## 部署说明

1. H5 端部署
   - 构建完成后，将 `dist/` 目录下的文件上传到服务器即可

2. 微信小程序部署
   - 在 HBuilderX 中构建完成后，使用微信开发者工具上传代码
   - 在微信公众平台提交审核并发布

## 贡献指南

1.  Fork 本仓库
2.  创建特性分支 (`git checkout -b feature/fooBar`)
3.  提交更改 (`git commit -am 'Add some fooBar'`)
4.  推送到分支 (`git push origin feature/fooBar`)
5.  提交 Pull Request

## 许可证

本项目采用 MIT 许可证。详情请见 [LICENSE](LICENSE) 文件。

## 联系我们

如果您有任何问题或建议，请联系我们：
- 邮箱：contact@uctoo.com
- 官网：www.uctoo.com