# 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`](https://www.electronjs.org/) project bootstrapped with [`Vite`](https://vitejs.dev/).
- App is built with [openim-sdk-wasm](https://github.com/openimsdk/open-im-sdk-web-wasm) library.
## Live Demo ๐
Give it a try at [https://web-enterprise.rentsoft.cn](https://web-enterprise.rentsoft.cn).
## Dev Setup ๐ ๏ธ
> It is recommended to use node version 16.x-18.x.
Follow these steps to set up a local development environment:
1. Run `npm install` to install all dependencies.
2. Modify the request address to your own OpenIM Server IP in the following files:
> Note: You need to [deploy](https://docs.openim.io/guides/gettingStarted/dockerCompose) OpenIM Server first, the default port of OpenIM Server is 10001, 10002, 10008.
- `src/config/index.ts`
```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";
```
3. Run `npm run dev` to start the development server. Visit [http://localhost:5173](http://localhost:5173) to see the result. An Electron application will be launched by default.
4. 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
1. Run the following command to build the web application:
```bash
npm run build
```
2. The build result will be located in the `dist` folder.
### Electron Application
1. Replace the contents of the `package_electron.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.
2. Run one of the following commands to build the Electron application:
- macOS:
```bash
npm run build:mac
```
- Windows:
```bash
npm run build:win
```
- Linux:
```bash
npm run build:linux
```
3. The build result will be located in the `package` folder.
## Community :busts_in_silhouette:
- ๐ [OpenIM Community](https://github.com/OpenIMSDK/community)
- ๐ [OpenIM Interest Group](https://github.com/Openim-sigs)
- ๐ [Join our Slack community](https://join.slack.com/t/openimsdk/shared_invite/zt-2ijy1ys1f-O0aEDCr7ExRZ7mwsHAVg9A)
- :eyes: [Join our wechat (ๅพฎไฟก็พค)](https://openim-1253691595.cos.ap-nanjing.myqcloud.com/WechatIMG20.jpeg)
## Community Meetings :calendar:
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](https://join.slack.com/t/openimsdk/shared_invite/zt-2ijy1ys1f-O0aEDCr7ExRZ7mwsHAVg9A) ๐ฏ, then you can search the Open-IM-Server pipeline to join
We take notes of each [biweekly meeting](https://github.com/orgs/OpenIMSDK/discussions/categories/meeting) in [GitHub discussions](https://github.com/openimsdk/open-im-server/discussions/categories/meeting), Our historical meeting notes, as well as replays of the meetings are available at [Google Docs :bookmark_tabs:](https://docs.google.com/document/d/1nx8MDpuG74NASx081JcCpxPgDITNTpIIos0DS6Vr9GU/edit?usp=sharing).
## Who are using OpenIM :eyes:
Check out our [user case studies](https://github.com/OpenIMSDK/community/blob/main/ADOPTERS.md) page for a list of the project users. Don't hesitate to leave a [๐comment](https://github.com/openimsdk/open-im-server/issues/379) and share your use case.
## License :page_facing_up:
OpenIM is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/openimsdk/open-im-server/tree/main/LICENSE) for the full license text.