# houge

**Repository Path**: monkeyss/houge

## Basic Information

- **Project Name**: houge
- **Description**: Houge（候鸽）- 反应式（Reactive）实时消息推送服务
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 101
- **Created**: 2021-10-22
- **Last Updated**: 2021-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![CI/CD](https://github.com/kevin70/houge/workflows/Houge%20CI/CD/badge.svg)](https://github.com/kevin70/houge/actions)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=houge&metric=coverage)](https://sonarcloud.io/dashboard?id=houge)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=houge&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=houge)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=houge&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=houge)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=houge&metric=security_rating)](https://sonarcloud.io/dashboard?id=houge)
[![Houge IM](https://pub.idqqimg.com/wpa/images/group.png)](https://qm.qq.com/cgi-bin/qm/qr?k=W8UiTh5rmq4O0SZJFnnWfh3SegzTGIWo&jump_from=webapi)

# Houge

![](docs/images/houge-logo/logo.png)

[We Are Reactive](https://www.reactivemanifesto.org/zh-CN)

Houge 是一款开源免费的**实时消息推送服务**，采用 [Spring Reactor](https://projectreactor.io/) 作为基础技术研发，完全采用反应式（Reactive Programming）编程模式实现。

服务端采用模块化设计，内置简洁通讯协议，扩展性强，可配置化，部署简单，集群等特点。

架构将连接服务与逻辑服务分离，可动态扩展集群节点。单台WS服务支持同时保持**百万链接**，天生拥有高吞吐量特性。

## 架构

![](docs/images/houge-arch-20210514.png)

## 技术栈

![](docs/images/houge-tech-stack.png)

## 交互流程图

![](docs/images/flow-20200330.png)

## 功能

- [x] 用户认证
- [x] 私人聊天
- [x] 群组聊天
- [x] 消息存储
- [x] 容器部署
- [x] 好友关系
- [x] 离线消息
- [x] 集群部署
- [ ] 系统监控
- [ ] 黑名单

## 文档

- [开发手册](docs/dev/index.md)
- [使用手册](docs/manual/index.md)
- [消息协议](docs/design/message_protocol.md)
- [安装部署](docs/deployment/install.md)
- [分布式消息 ID 设计](docs/design/message_id.md)
- [REST 接口文档](https://kk70.gitee.io/houge/houge-rest.html)

## 演示

### 私人消息

![私人聊天](docs/dev/images/328994a573dc.gif)

### 群组聊天

![群组消息](docs/dev/images/ce88baa135ab.gif)

### HTTP 发送消息

![HTTP 接口发送消息](docs/dev/images/a21fa82f2da7.gif)

### gRPC 发送消息

![gRPC 接口发送消息](docs/dev/images/4c04babfe553.gif)

## 感谢

Houge 的实现离不开源社区的支持，感恩为开源做出贡献的人。

## 捐赠

如果您觉得 Houge 做得不错，对您有实际的帮助，请支持我们更好的维护项目。

![Alipay](docs/images/alipay_qrcode.png)
![Wechat](docs/images/wechat_qrcode.png)