https://github.com/klintcheng/kim

King IM Cloud 分布式即时通信云IM
https://github.com/klintcheng/kim

Last synced: 2 months ago
JSON representation

King IM Cloud 分布式即时通信云IM

• Host: GitHub
• URL: https://github.com/klintcheng/kim
• Owner: klintcheng
• License: apache-2.0
• Created: 2021-06-28T09:00:05.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-02-05T07:43:24.000Z (11 months ago)
• Last Synced: 2024-08-01T11:16:42.595Z (5 months ago)
• Language: Go
• Homepage:
• Size: 4.26 MB
• Stars: 176
• Watchers: 2
• Forks: 58
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# KIM

King IM CLoud

## 简介

**kim 是一个高性能分布式即时通信系统。**

![structure.png](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/2633b07fd1a144d685ceed9be5f64911~tplv-k3u1fbpfcp-watermark.image)

- Web SDK： [Typescript SDK](https://github.com/klintcheng/kim_web_sdk)

- Flutter SDK： [Flutter SDK](https://github.com/szhua/KimSdk)

  - 由[@szhua](https://github.com/szhua)小友提供

## 环境准备

### 中间件安装

Kim依赖mysql、Consul和Redis。因此，在本地测试时需要准备相应环境。这里提供两种方式：

方式一： 通过docker-compose启动

> docker-compose -f "docker-compose.yml" up -d --build

方式二： docker分别启动

```cmd

docker run -itd --name kim_mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql

docker run \

    -d \

    -p 8500:8500 \

    -p 8600:8600/udp \

    --name=kim_consul \

    consul agent -server -ui -node=server-1 -bootstrap-expect=1 -client=0.0.0.0

docker run -itd --name kim_redis -p 6379:6379 redis

```

### 数据准备

1. 进入Mysql，修改访问权限：

   1. docker exec -it kim_mysql /bin/sh

   2. mysql -uroot -p123456

   3. GRANT ALL ON *.* TO 'root'@'%';

   4. flush privileges;

2. 创建数据库

   1. create database kim_base default character set utf8mb4 collate utf8mb4_unicode_ci;

   2. create database kim_message default character set utf8mb4 collate utf8mb4_unicode_ci;

## 启动服务

首先进入services中，分别启动三个服务：

```

go run main.go gateway

go run main.go server

go run main.go royal

```

或者，通过docker-compose启动：

```

docker-compose -f "docker-compose-kim.yml" up -d --build

```

访问Consul，可以查看服务启动状态：

> http://localhost:8500/ui