Przeglądaj źródła

优化:修改README

haiyang 1 tydzień temu
rodzic
commit
9b50c2d06c
1 zmienionych plików z 35 dodań i 3 usunięć
  1. 35 3
      README.md

+ 35 - 3
README.md

@@ -1,6 +1,38 @@
+# 券中心微信小程序
 
-<h1 align="center">
-  券中心微信小程序
-</h1>
+## 环境要求
 
+- Node.js >= 20
+- pnpm >= 9
+- 微信开发者工具 (用于小程序开发和调试)
+
+## 安装和启动
+
+### 安装依赖
+
+```bash
+pnpm install
+```
+
+## 注意事项
+
+1. **微信开发者工具配置**:
+   - 确保微信开发者工具已启用服务端口(设置 -> 安全 -> 服务端口)
+   - 开发环境使用 `dist/dev/mp-weixin` 目录
+   - 生产构建使用 `dist/build/mp-weixin` 目录
+
+2. **环境变量**:
+   - 开发环境变量配置在 `env/.env.development`
+   - 生产环境变量配置在 `env/.env.production`
+   - 所有环境变量必须以 `VITE_` 为前缀
+
+3. **项目配置**:
+   - 页面路由配置在 `src/pages/` 目录下(约定式路由)
+   - 应用清单配置在 `manifest.config.ts`
+   - Vite 构建配置在 `vite.config.ts`
+
+4. **开发流程**:
+   - 先执行 `pnpm dev` 启动 H5 服务
+   - 再执行 `pnpm dev:mp` 启动微信小程序开发
+   - 代码修改后会自动热更新到小程序开发者工具