34 lines
1.9 KiB
Markdown
34 lines
1.9 KiB
Markdown
# openvidu-electron
|
|
|
|
This is a minimal Electron application built with [electron-forge](https://www.electronforge.io/) and properly integrated with OpenVidu. It may be compiled to a native desktop application for Windows, Mac and Linux.
|
|
|
|
## Running the tutorial
|
|
|
|
To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
|
|
|
|
```bash
|
|
# Clone this repository
|
|
git clone https://github.com/OpenVidu/openvidu-tutorials
|
|
# Go into the repository
|
|
cd openvidu-tutorials/openvidu-electron
|
|
# Install dependencies
|
|
npm install
|
|
# Run the app
|
|
npm start
|
|
```
|
|
|
|
Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.
|
|
|
|
## Packaging your app
|
|
|
|
Electron Forge makes this extremely easy: `electron-forge make` (install it with `npm i -g @electron-forge/cli`). Boom, you're good to go. There you have your production-ready OpenVidu desktop app.
|
|
|
|
## Resources for Learning Electron
|
|
|
|
- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation
|
|
- [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - sample starter apps created by the community
|
|
- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app
|
|
- [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further
|
|
- [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron
|
|
- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs
|