# xapptool

**Repository Path**: xhpmayun/xapptool

## Basic Information

- **Project Name**: xapptool
- **Description**: XappTool是一款智能的APP安装追踪工具，提供自动获取安装参数、免填邀请码、轻松区分APP安装来源等功能，支持多种开发平台，助力开发者精准识别用户来源，提升用户体验。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: http://www.xapptool.cn
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-01-15
- **Last Updated**: 2026-05-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# XappTool — 移动应用归因与安装追踪平台

精准追踪 APP 安装来源，免填邀请码，渠道归因分析，多平台 SDK 支撑。

---

## 架构

```
宝塔面板 (Nginx + SSL)          Docker 容器
┌─────────────────────┐     ┌──────────────────────┐
│ 静态站 (merchant/SPA)│     │  app   :9797 (Webman) │
│ 反代 → 127.0.0.1:9797│     │  mysql :3306         │
│ SSL 证书自动续期       │     │  redis :6379         │
└─────────────────────┘     └──────────────────────┘
```

| 组件 | 技术栈 | 部署方式 |
|------|--------|---------|
| API 后端 | PHP 8.2 + Webman + ThinkORM | Docker |
| 商户后台 | Vue 3 + Vite + Element Plus | 宝塔静态站 |
| SDK | web / uniapp / react / flutter / android / ios / harmony | 静态文件 |
| 数据库 | MySQL 8.0 | Docker（持久化 /data/xapptool/mysql） |
| 缓存 | Redis 7 | Docker（持久化 /data/xapptool/redis） |

---

## 快速部署

### 环境要求

- **Docker** ≥ 24.0
- **系统**: Linux（CentOS / Ubuntu），2核+，4G 内存+
- **宝塔面板**: 已有 Nginx（证书自动续期）

### 三步部署

```bash
# 1. 配置域名和密码
vim .env.example     # 修改 API_BASE_URL / MERCHANT_URL / DB_PASSWORD
cp -f .env.example .env
bash tools/check_env_sync.sh

# 2. 放置数据库 SQL 包（仓库不提供，需联系作者获取）
#    放入目录: docker/mysql/init/

# 3. 一键启动
bash deploy.sh

# 4. 宝塔添加站点（SSL 自动续期）
#    静态站 → merchant.your-domain.com  (目录: merchant/dist)
#    反代站 → api.your-domain.com      (目标: http://127.0.0.1:9797)
```

## 文档

- 文档导航：[DOCS.md](file:///Users/xiaofang/Documents/www/php/xapptool/docs/DOCS.md)
- 生产部署：[DEPLOYMENT.md](file:///Users/xiaofang/Documents/www/php/xapptool/docs/DEPLOYMENT.md)
- 数据库 SQL 包（私有交付）：[DB_PACKAGE.md](file:///Users/xiaofang/Documents/www/php/xapptool/docs/DB_PACKAGE.md)

### .env 配置要点

```bash
# 只需修改以下变量（在 .env.example 中修改后同步生成 .env）
API_BASE_URL=https://api.your-domain.com
MERCHANT_URL=https://merchant.your-domain.com
SDK_BASE_URL=https://merchant.your-domain.com/sdk

DB_PASSWORD=your_secure_password
MYSQL_ROOT_PASSWORD=your_root_password
ADMIN_EMAIL=admin@your-domain.com
```

### 管理后台登录

默认管理员信息以你拿到的 SQL 包为准，首次登录后务必修改密码。

---

## 功能

| 模块 | 说明 |
|------|------|
| 渠道归因 | 多维度数据可视化，实时图表 |
| 免填邀请码 | 一键安装，自动绑定邀请关系 |
| 性能优化 | Redis 缓存，数据库索引优化，响应速度提升 70% |
| 安全防护 | API 限流，暴力破解防护，XSS/SQL 注入防护 |
| 统一认证 | JWT 令牌，单点登录，会员等级控制 |
| 管理后台 | 可视化仪表板，用户/商户/应用全生命周期管理 |
| SDK 多平台 | web / uniapp / react / flutter / android / ios / harmony |
| 数据导出 | JSON / PNG 格式，多维度数据分析 |

---

## 技术栈

- 后端: Webman (Workerman) + ThinkPHP ORM + PHP 8.2
- 前端: Vue 3 + Vite + Element Plus + ECharts
- 缓存: Redis
- 数据库: MySQL 8.0
- 部署: Docker + 宝塔面板

---

## 目录结构

```
xapptool/
├── .env                        # 运行时配置（由 .env.example 同步生成，不入库）
├── .env.example                # 唯一可编辑配置源（git 跟踪）
├── deploy.sh                   # 一键部署脚本
├── docker/
│   ├── docker-compose.yml      # 生产编排（仅监听 127.0.0.1，由宝塔反代接入）
│   ├── Dockerfile              # PHP 8.2 镜像
│   └── mysql/init/             # 放置私有交付 SQL 包（仓库不提供）
├── webman/                     # PHP 后端
│   ├── app/
│   ├── config/
│   │   └── xapptool.php        # 域名配置（从 env() 读取）
│   ├── start.php
│   └── support/bootstrap.php   # 加载根 .env
├── merchant/                   # Vue 前端
│   ├── src/
├── sdk/                        # 各平台 SDK 源码
└── docs/                       # 文档
```

---

## 运维

```bash
# 查看日志
docker logs xapptool_app -f --tail 100

# 重启
docker restart xapptool_app

# 备份数据库
docker exec xapptool_mysql mysqldump -u root -p"${MYSQL_ROOT_PASSWORD}" xapptool > backup.sql

# 更新部署
git pull && docker compose -f docker/docker-compose.yml up -d --build

# 健康检查
curl http://127.0.0.1:9797/api/performance/health
```

---

## API

| 端点 | 说明 |
|------|------|
| `GET /api/performance/health` | 健康检查 |
| `GET /api/performance/metrics` | 性能指标 |
| `/api/docs` | Swagger 文档 |

---

## 许可证

代码采用 MIT License。

数据库结构与初始化数据不随仓库提供，需要联系作者获取 SQL 包后才能部署运行，详见 [DB_PACKAGE.md](file:///Users/xiaofang/Documents/www/php/xapptool/docs/DB_PACKAGE.md)。