# houge

**Repository Path**: MemoryZy/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**: 2022-09-24
- **Last Updated**: 2022-09-24

## 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的目标：用最少的资源，做好1000K服务**。

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

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

****

**项目主要为研究学习响应式编程开发，其中有部分依赖库并不稳定，暂不建议应用于生产中。期望这个项目能为喜欢响应式编程的你提供一些有用的帮助，也欢迎对响应式编程有兴趣的小伙伴一起交流、沟通编程方面的乐趣与技巧。**

## 架构

![](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)

## 演示

- [单人消息](https://www.bilibili.com/video/BV1Cq4y1c7bN?share_source=copy_web)

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