{"id":13679077,"url":"https://github.com/genalhuang/genal-chat","last_synced_at":"2025-05-15T15:05:19.017Z","repository":{"id":39331895,"uuid":"274610956","full_name":"genalhuang/genal-chat","owner":"genalhuang","description":"🚀阿童木聊天室 nestjs+vue全栈聊天室 前后端分离 typescript一把梭","archived":false,"fork":false,"pushed_at":"2023-01-24T03:06:17.000Z","size":33417,"stargazers_count":1975,"open_issues_count":43,"forks_count":392,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-03-31T19:09:37.839Z","etag":null,"topics":["chatbot","chatroom","javascript","nestjs","nodejs","socket-io","typeorm","typescript","vue","vuex"],"latest_commit_sha":null,"homepage":"https://www.genal.fun","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/genalhuang.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-24T08:02:09.000Z","updated_at":"2025-03-30T03:29:15.000Z","dependencies_parsed_at":"2023-02-13T14:15:38.139Z","dependency_job_id":null,"html_url":"https://github.com/genalhuang/genal-chat","commit_stats":null,"previous_names":["genalhuang/genal-chat","genaller/genal-chat"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/genalhuang%2Fgenal-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/genalhuang%2Fgenal-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/genalhuang%2Fgenal-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/genalhuang%2Fgenal-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/genalhuang","download_url":"https://codeload.github.com/genalhuang/genal-chat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247721898,"owners_count":20985084,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot","chatroom","javascript","nestjs","nodejs","socket-io","typeorm","typescript","vue","vuex"],"created_at":"2024-08-02T13:01:01.692Z","updated_at":"2025-04-07T20:10:08.155Z","avatar_url":"https://github.com/genalhuang.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# 阿童木聊天室\n[![author](https://img.shields.io/badge/author-genaller-blue.svg)](https://github.com/genaller)\n[![author](https://img.shields.io/github/languages/top/genaller/genal-chat)](https://github.com/genaller/genal-chat)\n[![Node.js Version](https://img.shields.io/badge/node.js-10.16.3-blue.svg)](http://nodejs.org/download)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/genaller/genal-chat/blob/master/LICENSE)\n[![author](https://img.shields.io/github/stars/genaller/genal-chat?style=social)](https://github.com/genaller/genal-chat)\n\n\u003e [码云](https://gitee.com/edison_dec/genal-chat)\u003cbr\u003e\n\u003e\n\u003e ~~在线地址[www.genal.fun](http://www.genal.fun)~~（已失效，不打算部署了）\u003cbr\u003e\n\u003e\n\u003e 有建议请到issues区\n\n### 项目简介\n  😛 闲暇时间想做一个聊天室来巩固前端技能，于是在2020年6月24号就开始了阿童木聊天室的开发之旅。\u003cbr\u003e\n  😈 项目采用全typescript开发，这是为了以后的功能迭代打基础。当然，我本身也是很喜欢typescript的。\u003cbr\u003e\n  🧐 目前聊天室已经具备完整的聊天功能，~~今后会陆续开发更多酷炫的功能~~目前已经停止迭代！有兴趣的朋友可以自行fork去开发，你们随意改！我有时间再进行升级新功能!\u003cbr\u003e\n\n### 项目界面\n#### PC端\n\u003cimg src=\"./assets/v6_pc.png\" alt=\"PC\" style=\"max-width:800px\" /\u003e\n\n#### 移动端\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/v6_m1.png\" alt=\"Mobile\" width=\"350\"/\u003e\u003cimg src=\"./assets/v6_m2.png\" alt=\"Mobile\" width=\"350\"  hspace=\"50\"/\u003e\n\u003c/p\u003e\n\n### 功能介绍\n- 移动端兼容\n- 用户信息的修改(头像/用户名/密码)\n- 群聊/私聊\n- 创建群/加入群/退群/模糊搜索群\n- 添加好友/删好友/模糊搜索用户\n- 消息分页\n- 表情包\n- 图片发送/图片预览\n- 在线人数统计\n- 自定义主题\n- 重连提醒\n\n\n### 技术概览\n- **Typescript**：JavaScript 的一个超集，它最大的优势是提供了类型系统和提高了代码的可读性和可维护性。\n- **Vue2.6.x**：前端渐进式框架。\n- **Socket/io**：实现实时通信，websocket第三方库。\n- **Vuex**：专为 Vue.js 应用程序开发的状态管理模式。\n- **Nestjs**：是一个用于构建高效、可扩展的 Node.js 服务端应用框架，基于 TypeScript 编写并且结合了 OOP1、FP2、FRP3 的相关理念。\n- **Typeorm**: 支持最新的 JavaScript 特性并提供额外的特性以帮助你开发任何使用数据库的应用程序。\n- **ES6+**：采用ES6+语法，箭头函数、async/await等等语法很好用。\n- **SASS(SCSS)**：用SCSS做CSS预处理语言，可以使用最高效的方式，以少量的代码创建复杂的设计。\n\n### 数据库表结构设计\n![](./assets/database.png)\n\n### 环境配置\n- 数据库mysql 以及 chat数据库 (注意数据库格式为utf8mb4)\n- node v10.16.3\n\n### 运行项目\n1. 前端项目\n```js\ncd genal-chat-client \nnpm i\nnpm run serve\n```\n2. mysql配置\u003cbr\u003e\n如果mysql连不上并报错error: ER_NOT_SUPPORTED_AUTH_MODE， 是mysql版本不兼容导致，参考这篇文章https://blog.csdn.net/qq_41831345/article/details/83150502\u003cbr\u003e\n数据库没有sql脚本，直接改后端`app.module.ts`中的数据库密码，新建个`chat`数据库了就行\n\n3. 后端项目\n```js\ncd genal-chat-server\nnpm i\nnpm run start:dev\n```\n\n\n### 系统迭代记录\n\u003cdetails\u003e\n\u003csummary\u003e点击查看\u003c/summary\u003e\n\n### v1.0.0\n##### 功能\n- 新增用户\n- 新增群\n- 群聊\n##### v1.0.0界面\n![](./assets/1.png)\n\n### v2.0.0\n##### 功能\n- 群聊/私聊\n- 创建群/加入群聊/模糊搜索群\n- 添加好友/模糊搜索好友\n- 更改用户名/头像上传\n- 表情包\n- 消息分页\n##### v2.0.0界面\n![](./assets/2.png)\n\n### v3.0.0\n##### 功能\n- 群聊/私聊\n- 创建群/加入群聊/模糊搜索群\n- 添加好友/模糊搜索好友\n- 图片上传/粘贴发送图片/图片预览\n- 更改用户名/头像上传\n- 表情包\n- 消息分页\n##### v3.0.0界面\n同v2.0.0\n\n### v4.0.0\n##### 功能\n- 群聊/私聊\n- 创建群/加入群聊/模糊搜索群\n- 添加好友/模糊搜索好友\n- 图片上传/粘贴发送图片/图片预览\n- 更改用户名/头像上传\n- 表情包\n- 消息分页\n- 移动端兼容\n##### v4.0.0界面\n同v2.0.0\n\n### v5.0.0\n##### 功能\n- 群聊/私聊\n- 创建群/加入群聊/退群/模糊搜索群\n- 添加好友/删好友/模糊搜索好友\n- 图片上传/粘贴发送图片/图片预览\n- 更改用户名/头像上传\n- 表情包\n- 消息分页\n- 移动端兼容\n- 在线人数统计\n- 重连提醒\n##### v5.0.0界面\n![](./assets/v5_pc.png)\n\n### v6.0.0\n##### 功能\n- 移动端兼容\n- 用户信息的修改(头像/用户名/密码)\n- 群聊/私聊\n- 创建群/加入群/退群/模糊搜索群\n- 添加好友/删好友/模糊搜索用户\n- 消息分页\n- 表情包\n- 图片发送/图片预览\n- 在线人数统计\n- 自定义主题\n- 重连提醒\n##### v6.0.0界面\n![](./assets/v6_pc.png)\n\n\u003c/details\u003e\n\n### 作者\ngithub： [edison](https://github.com/genaller)\n\n### 贡献者列表\n[mtnbgx](https://github.com/mtnbgx)、[BoBoooooo](https://github.com/BoBoooooo)、[Nyaasu66](https://github.com/Nyaasu66)、[BeanCookie](https://github.com/BeanCookie)（排名不分先后）\n\n### 如何部署\n[阿童木聊天室部署说明](./阿童木聊天室部署说明.md)\n\n### 更多细节\n[用typescript打造一个性能强悍的web聊天室](https://github.com/genaller/strong-frontend/blob/master/learnNode/nest/%E8%81%8A%E5%A4%A9%E5%AE%A4/%E7%94%A8typescript%E6%89%93%E9%80%A0%E4%B8%80%E4%B8%AA%E6%80%A7%E8%83%BD%E5%BC%BA%E6%82%8D%E7%9A%84web%E8%81%8A%E5%A4%A9%E5%AE%A4.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenalhuang%2Fgenal-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenalhuang%2Fgenal-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenalhuang%2Fgenal-chat/lists"}