# Glide-IM

**Repository Path**: deng_zi/Glide-IM

## Basic Information

- **Project Name**: Glide-IM
- **Description**: A high performance, distributed, open source instant messaging app, write in Go.
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-03-10
- **Last Updated**: 2022-08-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Glide-IM

![i](_art/logo.png)

[![Go Report Card](https://goreportcard.com/badge/github.com/dengzii/go_im)](https://goreportcard.com/report/github.com/dengzii/go_im)

[README-EN](README_EN.md)

## 简介

[微信交流群](https://github.com/Glide-IM/GlideIM/issues/3)

本项目是我在 高性能IM, 微服务, 分布式, 项目架构等方面从零基础开始的一次实践, 希望可以给你带来一些帮助.

### 立即体验

[安卓体验 APP 下载](https://github.com/Glide-IM/Glide-IM-Android/releases)

[GlideIM Web (TODO)](https://github.com/Glide-IM/Glide-IM-Web)

## 相关仓库

[前端示例项目源码](https://github.com/Glide-IM/im_web)

[Android 端示例项目源码及 SDK](https://github.com/Glide-IM/Glide-IM-Android)

[Java SDK](https://github.com/Glide-IM/Glide-IM-Java-SDK)

## 项目构建

### 环境依赖

#### 单实例模式

- Redis
- MySQL

#### 分布式模式

- ETCD: `./cmd/script/etcd`
- NSQ: `./cmd/script/nsq`

### 入口

目录 `./cmd/run` 下为不同模式下的入口, 目录名即为服务/模式

- 分布式相关入口
    - api_rpc API 服务
    - dispatch 消息分发服务
    - gateway 用户连接, 网关服务
    - group 群聊服务
    - messaging 消息路由服务
- HTTP API
    - api_http 通过 HTTP 服务访问 API 接口
- 单实例运行
    - singleton

### 编译 .proto

项目中提交的 `/protobuf/gen` 目录就是已经编译好的 go 源码.

```shell
/protobuf/compile.sh
```

### 单实例运行

为了方便调试, 部分情况下只需要单实例运行即可, 例如调试客户端, 消息收发流程, 分布式部署的调试要部署整个流程是比较麻烦的, 所以一般是每个服务单独调试.

```shell
go run ./cmd/run/singleton/main.go
```

### 单实例可执行文件运行

如果觉得编译麻烦, 或者依赖出问题, 这里有编译好的.

这个是已经编译好的 Linux x64 环境下的单例模式可执行文件, 只需要在配置文件中改一下数据库相关即可运行.

Windows 环境在 [Releases](https://github.com/Glide-IM/Glide-IM/releases) 中下载即可.

```shell
wget https://raw.githubusercontent.com/Glide-IM/Glide-IM/master/cmd/script/glide_im/fast_deploy.sh && chmod +x fast_deploy.sh && ./fast_deploy.sh 
```

## 性能

单机支持约 20w(4万消息吞吐量) 活跃用户同时聊天(100Mbps), [查看测试数据](https://github.com/Glide-IM/Glide-IM/blob/master/doc/performance_test.md)

## 系统架构

介绍文章: [GlideIM - Golang 实现的高性能的分布式 IM](https://github.com/Glide-IM/Glide-IM/blob/master/doc/arch.md)

![i](_art/system_arch.png)

## 讨论群

- 微信群

![i](_art/wechat-group.png)

## 特别鸣谢

[![JetBrains](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)]( https://jb.gg/OpenSourceSupport)

## License

参见 [LICENSE](LICENSE)