Tailchat 开发环境搭建指南

Tailchat 是一款开源的即时通讯解决方案，本文将详细介绍如何搭建 Tailchat 的开发环境，帮助开发者快速上手项目开发。

环境准备

基础依赖服务

Tailchat 依赖以下三个核心服务，推荐使用 Docker 快速部署：

MongoDB 数据库服务

docker run -d --name mongo -p 27017:27017 mongo:4

MongoDB 是 Tailchat 的主要数据存储，这里使用 4.x 版本以保证兼容性。

Redis 缓存服务

docker run -d --name redis -p 6379:6379 redis

Redis 用于会话管理和实时消息推送等场景。

MinIO 对象存储服务

docker run -d \
  -p 19000:9000 \
  -p 19001:9001 \
  --name minio \
  -e "MINIO_ROOT_USER=tailchat" \
  -e "MINIO_ROOT_PASSWORD=com.msgbyte.tailchat" \
  minio/minio server /data --console-address ":9001"

MinIO 用于存储用户上传的文件和图片等资源。

环境变量配置

创建 .env 文件，配置上述服务的连接信息：

PORT=11000
MONGO_URL=mongodb://127.0.0.1:27017/tailchat
REDIS_URL=redis://localhost:6379/
MINIO_URL=127.0.0.1:19000
MINIO_USER=tailchat
MINIO_PASS=com.msgbyte.tailchat

Node.js 环境

Tailchat 基于 Node.js 开发，建议使用 Node.js 18.x 版本。Node.js 20.x 目前存在兼容性问题，不建议使用。

项目启动步骤

1. 安装依赖：

pnpm install

2. 启动开发服务器：

pnpm dev

3. 访问开发环境：

http://localhost:11011

项目目录结构解析

Tailchat 采用模块化设计，主要目录结构如下：

• apps/：非核心应用

  • cli/：命令行工具
  • github-app/：GitHub 集成机器人
  • oauth-demo/：第三方登录演示
  • widget/：网页嵌入组件

• client/：客户端代码

  • desktop/：桌面端
  • mobile/：移动端
  • packages/：公共依赖
  • shared/：平台无关公共代码
  • web/：Web 端
    • plugins/：前端插件
    • src/：源码目录

• packages/：公共包

  • types/：前后端共享类型定义

• server/：服务端代码

  • admin/：管理后台
  • models/：数据模型
  • plugins/：服务端插件
  • services/：微服务实现

• website/：项目官网

开发建议

1. 修改服务端配置时，可参考 server/.env.example 文件创建自定义配置

2. 开发过程中，pnpm dev 命令会自动监听文件变化并重新编译

3. 对于插件开发，可分别在 client/web/plugins 和 server/plugins 目录下创建前后端插件

4. 数据库模型定义位于 server/models 目录，修改后需要重启服务生效

通过以上步骤，您已成功搭建 Tailchat 的开发环境，可以开始进行功能开发和定制了。