标题: 零基础构建开源项目OpenIM桌面应用和pc web- Electron篇 [打印本页] 作者: 十念 时间: 2025-3-12 07:18 标题: 零基础构建开源项目OpenIM桌面应用和pc web- Electron篇 OpenIM 为开发者提供开源即时通讯 SDK,作为 Twilio、Sendbird 等云服务的替换方案。借助 OpenIM,开发者可以构建安全可靠的即时通讯应用,如 WeChat、Zoom、Slack 等。
本仓库基于开源版 OpenIM SDK 开发,提供了一款基于 Electron 的即时通讯应用。您可以使用此应用程序作为 OpenIM SDK 的参考实现。本项目同时引用了 @openim/electron-client-sdk 和 @openim/wasm-client-sdk,分别为 Electron 版本和 Web 版本的 SDK,可以同时构建 PC Web 程序和桌面应用(Windows、macOS、Linux)。
开发环境
在开始开发之前,请确保您的系统已安装以下软件:
操作系统:Windows 10 或更高版本、macOS 10.15 或更高版本
Node.js:版本 ≥ 16.x(手动安装 或使用 nvm 进行版本管理)
npm:版本 ≥ 6.x(随 Node.js 一起安装)
Git:用于代码版本控制
同时,您必要确保已经部署了最新版本的 OpenIM Server。接下来,您可以编译项目并连接自己的服务端进行测试。
运行环境
本应用支持以下浏览器和操作系统版本:
浏览器/操作系统 版本 状态
Chrome 78 及以上 ✅
Windows Windows 10 及以上 ✅
macOS 10.15 及以上 ✅
Linux 18.04 及以上 ✅
说明
Chrome:推荐使用最新版本以获得最佳体验。
操作系统:确保您的系统版本符合要求,以制止兼容性问题。
快速开始
按照以下步骤设置当地开发环境:
拉取代码
git clone https://github.com/openimsdk/openim-electron.git
cd openim-electron
安装依赖
npm install
修改配置
.env
如果没有修改过服务端默认端口,则只必要修改VITE_BASE_HOST为您的服务器 ip 即可,如需配置域名和 https 访问,可以参考nginx 配置,并采用最下方的配置项,并修改VITE_BASE_DOMAIN为您的域名。
VITE_BASE_HOST=your-server-ip
VITE_WS_URL=ws:// V I T E B A S E H O S T : 10001 V I T E A P I U R L = h t t p : / / VITE_BASE_HOST:10001 VITE_API_URL=http:// VITEBASEHOST:10001VITEAPIURL=http://VITE_BASE_HOST:10002
VITE_CHAT_URL=http://$VITE_BASE_HOST:10008
VITE_BASE_DOMAIN=your-server-domain