# go-im

**Repository Path**: flysmallbird/go-im

## Basic Information

- **Project Name**: go-im
- **Description**: go语言实现的im项目
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-21
- **Last Updated**: 2026-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Huayi IM - 基于 Go 的即时消息服务端

本项目是基于 Go 实现的，支持 RESTful API、Websocket 的即时通讯 App 的服务端。

## 项目运行
以下命令均在根目录下运行
- 1.启动项目：` make run `
- 2.进行e2e测试：` make e2e `
- 3.进行websocket测试：` make monitor `
- 4.运行前端项目：` make runapp `
- 5.停止项目：` make stop `

注：后端服务默认监听端口为 ` 8877 `，前端项目默认监听端口为 ` 5173 `

## 项目结构
重要文件如下：
- openapi.yaml  项目接口文档
- prodesc.md    项目介绍和功能要求
- README.md     项目说明文档

```
├── cmd
│   └── huayi-im        后端项目主程序启动
├── im-app              前端项目
├── test                测试
│   ├── e2e             e2e测试用例
│   ├── monitor         websocket测试用例
├── config              配置文件
│   ├── config.yaml     主配置文件
├── Makefile            项目构建脚本
├── openapi.yaml        项目接口文档
├── prodesc.md          项目介绍和功能要求
├── README.md           项目说明文档
```

## 项目部署
### 后端
1. 确保已安装 go1.25.0
2. 启动后端项目，在根目录下运行 ` go run ./cmd/huayi-im/main.go ` 
### 前端
1. 安装 Node.js（建议 LTS 版本）
2. 安装 pnpm（如果未安装）：` npm install -g pnpm `
3. 安装前端项目依赖：` cd im-app && pnpm install `