# go-chat

**Repository Path**: talkart/go-chat

## Basic Information

- **Project Name**: go-chat
- **Description**: Lumen IM 是一个网页版即时聊天系统，GO 后端
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 62
- **Created**: 2023-03-20
- **Last Updated**: 2023-03-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Lumen-IM 服务端（golang）

## 项目简介

Lumen IM 是一个网页版即时聊天系统，界面简约、美观、操作简单且容易进行二次开发。

##### 功能介绍

- 支持 WebSocket、TCP 协议接入
- 支持私聊及群聊以及房间聊天场景
- 支持服务水平扩展
- 支持聊天消息类型有 文本、代码块、图片及其它类型文件
- 支持聊天消息撤回、删除或批量删除、转发消息（逐条转发、合并转发）及群投票功能
- 支持编写个人笔记、支持笔记分享(好友或群)

[查看前端代码](https://github.com/gzydong/LumenIM)

## 项目预览

- 地址： [http://im.gzydong.club](http://im.gzydong.club)
- 账号： 18798272054 或 18798272055
- 密码： admin123

## 项目安装

1. 下载源码

```git
$ git clone https://github.com/gzydong/go-chat.git
```

1. 拷贝项目根目录下 config.example.yaml 文件为 config.yaml 并正确配置相关参数

``` bash
$ cp config.example.yaml config.yaml # 请务必正确配置相关参数
```

3. 安装依赖包

``` bash
$ go mod tidy
```

4. 安装相关依赖命令行工具

``` bash
$ make install
```

5. 初始化数据库

``` bash
$ make migrate
```

6. 开发环境下启动服务

``` bash
# 打开两个终端，分别运行下面两个命令

$ go run ./internal/http       # 本地启动 http 服务
$ go run ./internal/websocket  # 本地启动 websocket 服务

# 或者一下命令

$ make http                    # 本地启动 http 服务
$ make websocket               # 本地启动 websocket 服务
```

7. 编译后运行

``` bash
$ make build                   # 执行编译命令

# 执行后可在 ./bin 目录下看到
```