# app

**Repository Path**: heralink/app

## Basic Information

- **Project Name**: app
- **Description**: Heralink app example - demo SDK integration with backend/admin/web
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-14
- **Last Updated**: 2026-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Heralink App

heralink 应用示例 — 基于 heralink SDK 接入平台，包含示例后端、管理后台和前端页面。

**作者**: yichen · **邮箱**: 2782268022@qq.com · **技术交流 Q 群**: 714566447

## 包含子模块

| 子模块 | 说明 | 路由地址 |
|--------|------|----------|
| [server](server/) | 示例后端（Go） | `/app-api` |
| [admin](admin/) | 管理后台（Vue3） | `/app-admin` |
| [web](web/) | 前端页面（Vue3） | `/app-web` |

子模块远程仓库：
- `server` → https://gitee.com/heralink/app-server.git
- `web` → https://gitee.com/heralink/app-web.git
- `admin` → https://gitee.com/heralink/app-admin.git

## 快速启动

### 方式一：容器内全量编译（无需本地环境）

```bash
docker-compose up -d
```

### 方式二：显式编译部署

```bash
docker-compose -f docker-compose.build.yml up -d
```

### 方式三：宿主机编译后挂载运行

```bash
cd server && CGO_ENABLED=0 GOOS=linux go build -o bin . && cd ..
cd web && npm install && npm run build && cd ..
cd admin && npm install && npm run build && cd ..
docker-compose -f docker-compose.light.yml up -d
```

### 方式四：本地开发模式

```bash
docker-compose -f server/docker-compose.local.yml up -d
cd server && go run .        # 新终端
cd web && npm run dev         # 新终端
cd admin && npm run dev       # 新终端
```

启动后访问：http://localhost:1180/app-web/（前端页面），http://localhost:1180/app-admin/（管理后台）。

### 方式五：生产部署（本地编译产物上传）

详见 [deploy-README.md](deploy-README.md) — 本地编译 Go 二进制 + Vue 前端，只上传产物到服务器，增量更新。

```bash
bash deploy/scripts/deploy-local.sh [all|server|web|admin]
```

## 环境配置

所有配置项支持通过环境变量覆盖 `config.yaml`：

| 环境变量 | 说明 | 默认值 |
|---------|------|--------|
| `WS_URL` | 平台 WebSocket 地址 | `ws://localhost:8181/ws` |
| `HTTP_ADDR` | 平台 HTTP API 地址 | `http://localhost:8180` |
| `APP_ID` | App ID | `test_app` |
| `APP_API_KEY` | API Key | `test_app` |
| `APP_SECRET` | Secret | `test_secret_123456` |
| `STORAGE_TYPE` | 存储类型 (memory/mysql/sqlite) | `mysql` |
| `MYSQL_HOST` | MySQL 主机 | `127.0.0.1` |
| `MYSQL_PORT` | MySQL 端口 | `3320` |
| `MYSQL_DATABASE` | 数据库名 | `heralink_app` |
| `MYSQL_USER` | MySQL 用户 | `root` |
| `MYSQL_PASSWORD` | MySQL 密码 | `your_secure_password` |

## 首次部署

```bash
bash bootstrap.sh
```

自动创建平台测试用户和 App 凭证，初始化数据库表。

## API 参考

所有 API 前缀为 `/app-api`，认证方式为 `Authorization: Bearer {user_id}`。

详细接口文档见 [docs/api.md](docs/api.md)。

## 修改代码后重新编译

```bash
# 只重建后端
docker-compose -f docker-compose.build.yml build --no-cache app-server
docker-compose -f docker-compose.build.yml up -d

# 全部重建
docker-compose -f docker-compose.build.yml down
docker-compose -f docker-compose.build.yml build --no-cache
docker-compose -f docker-compose.build.yml up -d
```

> 注意：必须加 `--no-cache`，否则 Docker 不会重新编译。

## Git 提交

```bash
# 1. 先在子模块中提交推送
cd server && git add -A && git commit -m "feat: xxx" && git push && cd ..
cd web   && git add -A && git commit -m "feat: xxx" && git push && cd ..
cd admin && git add -A && git commit -m "feat: xxx" && git push && cd ..

# 2. 再提交推送父仓库（更新子模块指针）
git add -A && git commit -m "feat: xxx" && git push
```

必须先推送子模块，再推送父仓库。

## License

MIT