Skip to content

Latest commit

 

History

History
142 lines (96 loc) · 5.77 KB

Readme.md

File metadata and controls

142 lines (96 loc) · 5.77 KB
Raw

OpenIM Uniapp Demo 💬

OpenIM Docs • OpenIM Server • open-im-sdk-uniapp • openim-sdk-core


OpenIM Uniapp Demo 是一个基于本地插件、OpenIM Server 和 Uniapp 的开源即时通讯应用程序。它演示了如何使用 OpenIM 将即时消息功能快速集成到任何单一应用程序中。

您可以通过以下两种方式之一，获得使用源代码创建非由OpenIM生成的编译版本的许可：

  1. 根据自由软件基金会的GPL v.3.0许可，受此政策概述的例外情况的限制；或
  2. 通过与OpenIM联系（[email protected]）获取商业许可。

技术栈 🛠️

  • 这是一个 Uniapp 项目， 依赖于 HBuilderX 。开发前请先阅读 文档。

  • 注意：Demo 只是用于演示 SDK 的引入与使用，并不是不是一个完整的应用。

  • 运行 iOS 和 Android 必须安装原生插件，中间层 openim-uniapp-polyfill 结合 App 原生插件和 JSSDK 能力，兼容一套代码同时开发 APP、H5、小程序（ SDK 和 im-server 版本 >= 3.8.2 ）。

- 安装 openim-uniapp-polyfill 安装 @openim/client-sdk 安装 App原生插件 制作自定义基座调试
仅开发H5、小程序 直接参考 JSSDK 文档，SDK 调用参考 Browser、MiniProgram
仅开发App端 ✅ ❌ ✅ ✅
同时开发App端、H5和小程序 ✅ ✅ ✅ ✅

本地开发 🛠️

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

  1. 安装最新的正式版 HBuilderX。

  2. 运行 npm install 安装所有依赖项。

  3. 在以下文件中将配置文件修改为您自己的 AppID :

    使用 Hbuilder 打开 manifest.json

  4. 如果你想使用定位功能，在以下文件中将配置文件修改为您自己的高德地图 appkey :

    使用 Hbuilder 打开 manifest.json

  5. 在以下文件中将请求地址修改为您自己的OpenIM Server IP:

    注意: 需要先 部署 OpenIM Server, OpenIM Server 默认端口为 10001、10002、10008。

    • common -> config.js

       const wsUrl = "ws://your-server-ip:10001"
 const apiUrl = "http://your-server-ip:10002"
 const registerUrl = "http://your-server-ip:10008"

  6. 选择云插件 (必须)

    选择云插件需要选择您的项目 Appid 和输入 Android 包名称。

  7. 云打包自定义调试基座

  • 菜单 -> 运行 -> 运行到手机或模拟器 -> 制作自定义调试基座

  1. 在真实的机器或模拟器上运行 （ iOS 仅支持在真机调试 ）
  • 菜单 -> 运行 -> 运行到手机或模拟器 -> 运行到Android App基座

打包发布 🚀

使用原生App 云打包

  • 菜单 -> 发行 -> 原生App-云打包

社区参与 👥

社区会议 📆

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

我们的会议在 OpenIM Slack 🎯, 然后你可以搜索 Open-IM-Server 频道加入。

我们把每一次 双周会 记录在 GitHub discussions, 我们的历史会议记录以及会议回放可以在 Google Docs 📑。

谁在使用OpenIM 👀

查看我们的 用户案例研究 页面以获取项目用户列表。 不要犹豫，留下 评论 并分享您的用例。

授权许可 📄

OpenIM 是在 Apache 2.0 许可下授权的. 查看 LICENSE 获取完整的许可文本。