OpenIM Electron Demo 💬💻

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

OpenIM Electron Demo is an open-source instant messaging application built on OpenIM SDK Wasm, OpenIM Server, and Electron. It demonstrates how to quickly integrate instant messaging capabilities into any web app using OpenIM.

Tech Stack 🛠️

This is a Electron project bootstrapped with Vite.
App is built with openim-sdk-wasm library.

Live Demo 🌐

Give it a try at https://web-enterprise.rentsoft.cn.

Dev Setup 🛠️

It is recommended to use version 16.x-18.x.

Follow these steps to set up a local development environment:

Run npm install to install all dependencies.
Modify the request address to your own OpenIM Server IP in the following files:

Note: You need to deploy OpenIM Server first, the default port of OpenIM Server is 10001, 10002, 10008.
- src/utils/open_im_sdk_wasm/api/config.js
```
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";
```
Run npm run dev to start the development server. Visit http://localhost:5173 to see the result. An Electron application will be launched by default.
Start development! 🎉

Build 🚀

This project allows building web applications and Electron applications separately, but there will be some differences during the build process.

Web Application

Replace the contents of the package_build_web.json file with package.json, removing dependencies required for Electron to run. Also, modify the build script.
Run the following command to build the web application:
```
npm run build
```
The build result will be located in the dist folder.

Electron Application

Replace the contents of the package_build.json file with package.json, keeping only the dependencies required for Electron to function. This significantly reduces the package size. Also, modify the packaging script.

Update the path for wasm import in the utils/open_im_sdk_wasm/api/database/instance.js file:

- SQL = await initSqlJs({ locateFile: () => '/sql-wasm.wasm' });
+ SQL = await initSqlJs({ locateFile: () => '../sql-wasm.wasm' });

Run one of the following commands to build the Electron application:
- macOS:
```
npm run build:mac
```
- Windows:
```
npm run build:win
```
- Linux:
```
npm run build:linux
```
The build result will be located in the package folder.

Community 👥

Community Meetings 📆

We want anyone to get involved in our community and contributing code, we offer gifts and rewards, and we welcome you to join us every Thursday night.

Our conference is in the OpenIM Slack 🎯, then you can search the Open-IM-Server pipeline to join

We take notes of each biweekly meeting in GitHub discussions, Our historical meeting notes, as well as replays of the meetings are available at Google Docs 📑.

Who are using OpenIM 👀

Check out our user case studies page for a list of the project users. Don't hesitate to leave a 📝comment and share your use case.

License 📄

OpenIM is licensed under the Apache 2.0 license. See LICENSE for the full license text.

dmulxw / openim-electron-demo Goto Github PK