docs: 更新 README 文档以反映项目实际内容
更新项目介绍、技术栈、功能特点、项目结构等内容,移除默认模板信息,添加开发环境说明和移动端适配注意事项
This commit is contained in:
parent
123bdc4018
commit
e504619da7
67
README.md
67
README.md
|
|
@ -1,5 +1,66 @@
|
|||
# Vue 3 + TypeScript + Vite
|
||||
# 结婚证书 H5 应用
|
||||
|
||||
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
|
||||
## 项目介绍
|
||||
这是一个基于 Vue 3 + TypeScript + Vite 构建的结婚证书 H5 应用,提供结婚证书信息填写、展示和核销功能。
|
||||
|
||||
Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
|
||||
## 技术栈
|
||||
- **前端框架**: Vue 3
|
||||
- **语言**: TypeScript
|
||||
- **构建工具**: Vite
|
||||
- **UI 框架**: Tailwind CSS
|
||||
- **路由**: Vue Router
|
||||
- **HTTP 客户端**: Axios
|
||||
|
||||
## 功能特点
|
||||
- 结婚证书信息表单填写
|
||||
- 验证码输入与验证
|
||||
- 二维码展示与核销状态显示
|
||||
- 移动端适配与键盘优化
|
||||
- 响应式设计,适配不同尺寸设备
|
||||
|
||||
## 项目结构
|
||||
```
|
||||
src/
|
||||
├── App.vue # 应用主组件
|
||||
├── main.ts # 应用入口
|
||||
├── pages/ # 页面组件
|
||||
│ └── home/ # 首页
|
||||
├── components/ # 通用组件
|
||||
├── router/ # 路由配置
|
||||
├── services/ # API 服务
|
||||
├── utils/ # 工具函数
|
||||
├── types/ # TypeScript 类型定义
|
||||
└── assets/ # 静态资源
|
||||
```
|
||||
|
||||
## 开发环境
|
||||
|
||||
### 安装依赖
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
### 启动开发服务器
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
### 构建生产版本
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
### 预览构建结果
|
||||
```bash
|
||||
pnpm preview
|
||||
```
|
||||
|
||||
## 移动端适配说明
|
||||
项目已针对移动端设备进行了优化,包括:
|
||||
- 响应式视口设置
|
||||
- 键盘弹出时的界面处理
|
||||
- 触摸交互优化
|
||||
|
||||
## 注意事项
|
||||
- 开发环境 API 地址配置在 `.env.development` 文件中
|
||||
- 生产环境 API 地址配置在 `.env.production` 文件中
|
||||
|
|
|
|||
Loading…
Reference in New Issue