# go_message

**Repository Path**: wokaixin/go_message

## Basic Information

- **Project Name**: go_message
- **Description**: # GO语言实时通信工具

基于Go语言开发的高性能实时通信工具，支持百万级在线连接，提供单聊、群聊、消息推送等核心功能。
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GO Message

高性能实时通信 SaaS 平台。提供单聊、群聊、房间通信、主题订阅、消息推送能力。开发者注册后创建应用，获取 API Key，集成 SDK 即可获得实时通信能力。

## 快速开始

### 本地开发（推荐）

```bash
# 1. 启动 MySQL/Redis/Nginx
docker-compose -f docker-compose.local.yml up -d

# 2. 启动主平台
cd backend && go run main.go

# 3. 新终端，启动 Demo
cd demo/backend && go run .
```

或双击 `start-local.bat` 一键启动。

### Docker 全容器部署

```bash
docker-compose up -d  # 需要能拉取 Docker 镜像
```

### 端口说明

| 端口 | 服务 |
|------|------|
| 80 | 前端页面（Nginx） |
| 8080 | 主平台 API |
| 8081 | WebSocket |
| 8082 | TCP |
| 9090 | Demo 后端 |
| 3310 | MySQL |
| 6379 | Redis |

文档入口: [docs/index.md](docs/index.md)

## 项目结构

| 模块 | 说明 |
|------|------|
| [backend/](backend/) | Go 服务端（HTTP/WS/TCP 三服务器） |
| [admin/](admin/) | 超管运营后台（Vue3） |
| [docs/](docs/) | 文档 |
| [demo/](demo/) | 开发者参考实现 + SDK |

## 文档

| 链接 | 内容 |
|------|------|
| [架构设计](docs/01-architecture/overview.md) | 三服务器并行、消息流转、认证、集群 |
| [API 参考](docs/02-api/rest-api.md) | REST / WebSocket / TCP / 错误码 |
| [SaaS 规划](docs/04-saas-plan/overview.md) | 平台方案、数据库设计、配额体系、Key 轮换 |
| [集成指南](docs/05-integration/quickstart.md) | 5 分钟接入、SDK 参考、DB 选型 |
| [开发指南](docs/06-development/setup.md) | 环境搭建、编码规范、测试 |

## License

MIT