Skip to content

Latest commit

 

History

History
105 lines (75 loc) · 4.25 KB

README.zh-CN.md

File metadata and controls

105 lines (75 loc) · 4.25 KB
Raw

OpenIM Electron Demo 💬💻

OpenIM Docs • OpenIM Server • openim-sdk-wasm • openim-sdk-core


OpenIM Electron Demo 是一个基于openim-sdk-wasm、openim-server和Electron构建的开源即时通讯应用程序。它演示了如何使用 OpenIM 快速的将即时通讯功能集成到任何 Web 应用程序中。

技术栈 🛠️

在线演示 🌐

在 https://web-enterprise.rentsoft.cn 上体验一下。

开发设置 🛠️

建议使用 node 版本 16.x-18.x。

按照以下步骤设置本地开发环境：

  1. 运行 npm install 来安装所有依赖项。
  2. 在以下文件中将请求地址修改为您自己的 OpenIM 服务器 IP：

    注意：您需要先部署 OpenIM 服务器，默认端口为 10001、10002、10008。

    • src/config/index.ts 
      export const WS_URL = "ws://your-server-ip:10001";
export const API_URL = "http://your-server-ip:10002";
export const USER_URL = "http://your-server-ip:10008";
  3. 运行 npm run dev 来启动开发服务器。访问 http://localhost:5173 查看结果。默认情况下将启动 Electron 应用程序。
  4. 开始开发！ 🎉

构建 🚀

该项目允许分别构建 Web 应用程序和 Electron 应用程序，但在构建过程中会有一些差异。

Web 应用程序

  1. 运行以下命令来构建 Web 应用程序： 
    npm run build
  2. 构建结果将位于 dist 文件夹中。

Electron 应用程序

  1. 使用 package.json 替换 package_electron.json 文件的内容，只保留 Electron 运行所需的依赖项。这将显著减小包的大小。同时，修改打包脚本。
  2. 运行以下命令之一来构建 Electron 应用程序：
    • macOS: 
      npm run build:mac
    • Windows: 
      npm run build:win
    • Linux: 
      npm run build:linux
  3. 构建结果将位于 package 文件夹中。

社区 👥

社区会议 📆

我们希望任何人都能参与我们的社区并贡献代码，我们提供礼品和奖励，并欢迎您每个星期四晚上加入我们。

我们的会议在 OpenIM Slack 🎯，然后您可以搜索 Open-IM-Server 管道加入

我们在GitHub discussions中记录了每一次双周会议的内容，我们的历史会议记录以及会议的回放都可以在Google Docs 📑中找到。

谁在使用 OpenIM 👀

查看我们的用户案例页面，以获取正在使用改项目用户的列表。不要犹豫留下📝 评论并分享您的使用情况。

LICENSE 📄

OpenIM 在 Apache 2.0 许可下发布。查看LICENSE以获取完整的信息。