ykt-sms-bridge-h5/README.md

73 lines
1.1 KiB
Markdown
Raw Normal View History

2026-06-04 16:02:30 +08:00
# YKT Friend Bridge H5
短信好友邀请中转页。发布包名为 `sms.zip`,默认短路径为 `/sms/{recordId}`
## Local Dev
```bash
npm run dev
```
本地默认读取 `.env.development`
```text
api_url=http://localhost:8080
```
默认地址:
```text
http://localhost:5174/sms/{recordId}
```
本地服务端默认读取:
```text
http://localhost:8080/sms/friend-link/{recordId}/data
```
## Build
```bash
npm run build
npm run package
```
生产默认读取 `.env.production`
```text
api_url=https://ykt.youcan365.com
```
产物:
```text
dist/sms/
sms.zip
```
`sms.zip` 内部自带 `sms/` 目录,上传后解压到站点根目录即可:
```bash
unzip -o sms.zip -d /var/www
```
`api_url` 必须配置,页面内部接口只请求:
```text
/sms/friend-link/{recordId}/data
```
如需覆盖服务端域名,打包前传入:
```bash
api_url=https://your-api-domain.com npm run package
```
后端必须配置 H5 域名,生成短信链接时会使用短路径:
```text
CONFIG_SMS_FRIEND_LINK_BASE_URL=https://your-h5-domain.com
生成链接https://your-h5-domain.com/sms/{recordId}
```