# gokeep-server

**Repository Path**: xuning/gokeep-server

## Basic Information

- **Project Name**: gokeep-server
- **Description**: GoKeep 是一款100%自研的国产IM即时通讯系统，从底层开始构建，具备高性能、高时效性、可扩展的特点，并提供服务端管理端的项目代码，该项目开源协议为MIT协议，您可以免费进行商用以及分发。
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: http://www.gokeep.org
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-02-25
- **Last Updated**: 2025-01-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## GoKeep [![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)

gokeep 是一款100%自研的国产IM即时通讯系统，从底层开始构建，具备高性能、高时效性、可扩展的特点，并提供服务端管理端的项目代码，该项目开源协议为MIT协议，您**可以免费进行商用以及分发**。

**[文档地址官网](https://gokeep.org)**

### 🍁项目特色
1. 轻量级、高性能、低延迟、可扩展 , 文档齐全。
2. 代码完全开源（MIT协议），可用于学习、商用以及二次分发。
3. 学习成本低，仅需会使用Java语言即可进行二次开发维护 。
4. 功能强大但资源消耗低，可以使企业低成本使用。

### 系统架构图

------

<img src="doc/assets/系统架构图.png" alt="系统架构图" style="zoom: 80%;" />

### 🍭技术栈
- 支持平台：x86-64
- 运行环境：Open-JDK17
- 基础框架：SpringBoot3.0.2
- 数据通信：SmartSocket
- 数据协议：Socket & ProtoBuf
- 数据存储：Minio、Mongodb
- 数据缓存：Caffieine、Redis
- ORM框架：Springboot-data-jpa
- 操作工具：Hutool

### 🎈相关项目
| 项目 | Gitee | GitHub |
|---|-------|---|
|服务端| 待开发   |待开发|
|客户端-PC|待开发    |待开发|
|客户端-移动| 待开发    |待开发|
|客户端-WEB| 待开发    |待开发|
|开放平台SDK-JAVA| 待开发   |待开发|
|开放平台SDK-NODE| 待开发   |待开发|

###  ⚙构建
#### 第一种构建方式：基于docker一键部署
```shell
- 进入项目根目录执行：docker-compose up -d
```
#### 第二种构建方式：基于Maven进行打包
```shell
- 启动相关的中间件服务（mongodb、minio、redis）
- 配置：application/src/main/resources/application.yml
- 进入项目根目录执行：mvn package
- 打包执行完毕后会在项目目录下的dist目录中生成打包文件
- 启动：java -jar gokeep-server.jar

```
#### 第三种构建方式：在IDE中启动项目
```text
- 引入或打开项目，引入maven依赖
- 启动相关的中间件服务（mongodb、minio、redis）
- 配置：application/src/main/resources/application.yml
- 启动主类：application/src/main/java/org/gokeep/application/Bootstrap.java
```


### 🍩支持
- 支持两种方式，企业模式和自由模式
- 感谢码云提供的代码托管和 Pages 服务。

### 🥳加入社群

- **官方QQ群：** 入群条件：