chore: add README

README.md

@@ -1,39 +1,98 @@
-# Vue3Ts
+## 项目简介
 
-#### 介绍
+小兔鲜儿项目包含从首页浏览商品，商品详情，微信登录，加入购物车，提交订单，微信支付，订单管理等功能。
-{**以下是 Gitee 平台说明，您可以替换此简介**
-Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
-无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}
 
-#### 软件架构
+当前仓库为小兔鲜儿的**项目模板**。
-软件架构说明
 
+### 技术栈
 
-#### 安装教程
+- 前端框架：[uni-app](https://uniapp.dcloud.net.cn/) (Vue3 + TS + Setup)
+- 状态管理：[pinia](https://pinia.vuejs.org/zh/)
+- 组件库：[uni-ui](https://uniapp.dcloud.net.cn/component/uniui/uni-ui.html)
 
-1.  xxxx
+## 资料说明
-2.  xxxx
-3.  xxxx
 
-#### 使用说明
+### 📀 视频学习
 
-1.  xxxx
+[https://www.bilibili.com/video/BV1Bp4y1379L/](https://www.bilibili.com/video/BV1Bp4y1379L/?share_source=copy_web&vd_source=2ac50d29193927b3c8597537dc4bc81d)
-2.  xxxx
-3.  xxxx
 
-#### 参与贡献
+### 📗 接口文档
 
-1.  Fork 本仓库
+[https://www.apifox.cn/apidoc/shared-0e6ee326-d646-41bd-9214-29dbf47648fa/](https://www.apifox.cn/apidoc/shared-0e6ee326-d646-41bd-9214-29dbf47648fa/)
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
 
+### ✏️ 在线笔记
 
-#### 特技
+[https://megasu.gitee.io/uni-app-shop-note/](https://megasu.gitee.io/uni-app-shop-note/)
 
-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
+### 📦 项目源码
-2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
+
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
+[https://gitee.com/Megasu/uniapp-shop-vue3-ts/](https://gitee.com/Megasu/uniapp-shop-vue3-ts/)
-4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
+
-5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
+## 运行程序
-6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+
+1. 安装依赖
+
+```shell
+# npm
+npm i --registry=https://registry.npmmirror.com
+
+# pnpm
+pnpm i --registry=https://registry.npmmirror.com
+```
+
+2. 运行程序
+
+```shell
+# 微信小程序端
+npm run dev:mp-weixin
+
+# H5端
+npm run dev:h5
+
+# App端
+需 HbuilderX 工具，运行 - 运行到手机或模拟器
+```
+
+3. 微信开发者工具导入 `/dist/dev/mp-weixin` 目录
+
+### 工程结构解析
+
+```
+├── .husky                     # Git Hooks
+├── .vscode                    # VS Code 插件 + 设置
+├── dist                       # 打包文件夹（可删除重新打包）
+├── src                        # 源代码
+│   ├── components             # 全局组件
+│   ├── composables            # 组合式函数
+│   ├── pages                  # 主包页面
+│       ├── index               # 首页
+│       ├── category            # 分类页
+│       ├── cart                # 购物车
+│       ├── my                  # 我的
+│       └── login               # 登录页
+│   ├── services               # 所有请求
+│   ├── static                 # 存放应用引用的本地静态资源的目录
+│       ├── images              # 普通图片
+│       └── tabs                # tabBar 图片
+│   ├── stores                 # 全局 pinia store
+│       ├── modules             # 模块
+│       └── index.ts            # store 入口
+│   ├── styles                 # 全局样式
+│       └── fonts.scss          # 字体图标
+│   ├── types                  # 类型声明文件
+│       └── component.d.ts      # 全局组件类型声明
+│   ├── utils                  # 全局方法
+│   ├── App.vue                # 入口页面
+│   ├── main.ts                # Vue初始化入口文件
+│   ├── pages.json             # 配置页面路由等页面类信息
+│   ├── manifest.json          # 配置appid等打包信息
+│   └── uni.scss               # uni-app 内置的常用样式变量
+├── .editorconfig              # editorconfig 配置
+├── .eslintrc.cjs              # eslint 配置
+├── .prettierrc.json           # prettier 配置
+├── .gitignore                 # git 忽略文件
+├── index.html                 # H5 端首页
+├── package.json               # package.json 依赖
+├── tsconfig.json              # typescript 配置
+└── vite.config.ts             # vite 配置
+```