From 9d7df4765512a7f300d0fb8d1be4b3c214c70920 Mon Sep 17 00:00:00 2001
From: lucl <lucl@xiaopeng.com>
Date: 星期二, 03 二月 2026 09:26:35 +0800
Subject: [PATCH] docs: 更新了 readme 文档，说明网络请求的用法和文件架构
---
README.md | 160 ++++++++++++++++++++++++++--------------------------
1 files changed, 80 insertions(+), 80 deletions(-)
diff --git a/README.md b/README.md
index 2b10227..3bd3a72 100644
--- a/README.md
+++ b/README.md
@@ -1,80 +1,80 @@
-
-# 小鹏小程序
-
-## 启动配置
-需补全 config 目录下 dev.js/prod.js 的必填appId/密钥
-```
-const XP_APPID_MAP = {
- weapp: '"xxxxxxx"', // 用户中心登录appId
-};
-const XP_SECRET_MAP = {
- weapp: '"xxxxxxx"', // 用户中心登录密钥
-};
-const PLATFORM_APPID_MAP = {
- weapp: '"xxxxxxx"', // 微信小程序平台 appId
-};
-```
-
-补全 project.config.json 文件的 appId
-```
-"packOptions": {
- "ignore": [],
- "include": []
- },
- "appid": "xxxxxxxxxxxxx",
- "projectname": "xp-robotaxi-miniprogram",
- "libVersion": "3.13.0"
-```
-
-
-## 环境依赖
-```js
-Taro@3.4.9
-node@14.x
-```
-
-## 建议使用 nvm 进行 node 版本管理
-[nvm 安装文档](https://github.com/nvm-sh/nvm)
-
-```js
-// 安装 node@14.x
-nvm install v14.21.3
-
-// 切换node版本
-nvm use 14
-```
-
-## 安装依赖
-```js
-// 安装 cli
-npm install -g @tarojs/cli@3.4.9
-
-// 安装本地依赖
-npm install
-```
-
-## 运行命令
-```js
-// 本地开发（预发环境）
-npm run dev:weapp
-
-// 本地开发（切换线上环境变量）
-npm run dev:weapp_prod
-
-// 本地预览（开启压缩模式）
-npm run preview:weapp
-
-// 生产发布
-npm run build:weapp
-```
-
-## robotaxi 开发约束
-- 所有 robotaxi 相关代码统一放在 `src/robotaxi` 子包目录中
-- `src/robotaxi` 目录以外文件只能新增，不要修改已有文件(配置文件除外)
-- 所有接口请求通过 `request.ts` 进行统一处理，request 已经对接口协议和登录态传递进行了统一封装
-
-
-## 登录相关说明
-- 页面通过检查 storage 中是否缓存 `otp` 标识确定用户是否已登录，具体可以参考 `checkOtp` 方法
-- 用户没有登录可以通过跳转到 `/pages/user/login` 页面进行登录，具体可以参考 `checkOtp` 方法
-- 如果 `otp` 已过期或实效，则通过 `request.ts` 封装的方法自动跳转到登录页进行续登或重新登录
+
+# 小鹏小程序
+
+## 启动配置
+需补全 config 目录下 dev.js/prod.js 的必填appId/密钥
+```
+const XP_APPID_MAP = {
+ weapp: '"xxxxxxx"', // 用户中心登录appId
+};
+const XP_SECRET_MAP = {
+ weapp: '"xxxxxxx"', // 用户中心登录密钥
+};
+const PLATFORM_APPID_MAP = {
+ weapp: '"xxxxxxx"', // 微信小程序平台 appId
+};
+```
+
+补全 project.config.json 文件的 appId
+```
+"packOptions": {
+ "ignore": [],
+ "include": []
+ },
+ "appid": "xxxxxxxxxxxxx",
+ "projectname": "xp-robotaxi-miniprogram",
+ "libVersion": "3.13.0"
+```
+
+
+## 环境依赖
+```js
+Taro@3.4.9
+node@14.x
+```
+
+## 建议使用 nvm 进行 node 版本管理
+[nvm 安装文档](https://github.com/nvm-sh/nvm)
+
+```js
+// 安装 node@14.x
+nvm install v14.21.3
+
+// 切换node版本
+nvm use 14
+```
+
+## 安装依赖
+```js
+// 安装 cli
+npm install -g @tarojs/cli@3.4.9
+
+// 安装本地依赖
+npm install
+```
+
+## 运行命令
+```js
+// 本地开发（预发环境）
+npm run dev:weapp
+
+// 本地开发（切换线上环境变量）
+npm run dev:weapp_prod
+
+// 本地预览（开启压缩模式）
+npm run preview:weapp
+
+// 生产发布
+npm run build:weapp
+```
+
+## robotaxi 开发约束
+- 所有 robotaxi 相关代码统一放在 `src/robotaxi` 子包目录中
+- `src/robotaxi` 目录以外文件只能新增，不要修改已有文件(配置文件除外)
+- 所有接口请求通过 `request.ts` 进行统一处理，request 已经对接口协议和登录态传递进行了统一封装
+
+
+## 登录相关说明
+- 页面通过检查 storage 中是否缓存 `otp` 标识确定用户是否已登录，具体可以参考 `checkOtp` 方法
+- 用户没有登录可以通过跳转到 `/pages/user/login` 页面进行登录，具体可以参考 `checkOtp` 方法
+- 如果 `otp` 已过期或实效，则通过 `request.ts` 封装的方法自动跳转到登录页进行续登或重新登录
--
Gitblit v1.7.1