目录
目录README.md

智能辅助生成的简单即时通讯 (IM) 应用

1. 描述

本项目是一个简单的即时通讯 (IM) 应用,旨在探索和评估现代编程助手(如 Google Gemini 2.5 Pro 和 GitHub Copilot)在辅助软件开发全流程中的作用和效率。该系统致力于为用户提供基础的即时沟通服务,包括账户管理、好友互动、群组交流、消息传递与同步(文本和图片),以及必要的搜索功能。

该项目采用前后端分离架构,前端使用 React,后端使用 Go (Gin框架)。 `

2. 主要功能

系统的核心功能模块包括:

  • 用户账户管理:
    • FR-ACCOUNT-001: 创建账户
    • FR-ACCOUNT-002: 用户登录
    • FR-ACCOUNT-003: 用户退出登录
  • 好友管理:
    • FR-FRIEND-001: 添加好友 (搜索用户、发送/处理好友请求)
    • FR-FRIEND-002: 通讯录 (好友列表)
  • 群组聊天管理:
    • FR-GROUP-001: 加入群聊
    • FR-GROUP-002: 搜索群聊
    • (扩展功能可能包括创建群组、管理群成员等)
  • 消息传递:
    • FR-MESSAGE-001: 发送文本消息 (私聊和群聊)
    • FR-MESSAGE-002: 发送图片消息 (私聊和群聊)
    • FR-MESSAGE-003: 获取和同步消息 (实时接收、历史消息拉取)
  • 搜索功能:
    • FR-SEARCH-001: 搜索好友 (通讯录内或全局)
    • FR-SEARCH-002: 群聊中搜索聊天记录

3. 技术栈

  • 后端:
    • 语言: Go
    • Web 框架: Gin
    • 数据库: PostgreSQL
    • ORM: GORM (用于与数据库交互)
  • 前端:
    • 语言: JavaScript
    • 框架/库: React
    • 样式: Tailwind CSS
  • 实时通讯: WebSocket
  • 版本控制: Git, GitHub
  • 开发辅助工具:
    • Google Gemini 2.5 Pro (用于需求分析、文档生成、代码解释、测试设计等)
    • GitHub Copilot (用于代码补全、片段生成等)

4. 安装与运行

前提条件:

  • Git
  • Go (推荐最新稳定版)
  • Node.js 和 npm/yarn (推荐最新LTS版)
  • Docker

4.1 后端

  1. 进入后端目录:
    cd im_system_backend
  2. 启动数据库服务(PostgreSQL,使用 Docker):
    docker compose up -d
  3. 配置环境变量:
    • 根据实际情况修改.env,填写数据库、JWT 等配置。
  4. 安装依赖:
    go mod tidy
  5. 启动后端服务:
    go run main.go
    后端服务默认运行在 http://localhost:8080

4.2 前端

  1. 进入前端目录:
    cd im_system_frontend
  2. 安装依赖:
    npm install
  3. 启动前端开发服务器:
    npm start
    前端应用默认运行在 http://localhost:3000,并会自动在浏览器中打开。

5. 文档

本项目的详细文档位于 docs 目录,包括需求规格说明、设计文档、API 接口文档等。

关于
13.2 MB
邀请码
    Gitlink(确实开源)
  • 加入我们
  • 官网邮箱:gitlink@ccf.org.cn
  • QQ群
  • QQ群
  • 公众号
  • 公众号

©Copyright 2023 CCF 开源发展委员会
Powered by Trustie& IntelliDE 京ICP备13000930号