neoris/openvidu-livekit-tutorials
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

openvidu-electron README update

Browse Source
This commit is contained in:
pabloFuente 2019-06-05 14:29:11 +02:00
parent 0ed170642d
commit 226ad79827
1 changed files with 9 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
openvidu-electron/README.md
View File

@ -1,33 +1,13 @@
# openvidu-electron
[![License badge](https://img.shields.io/badge/license-Apache2-orange.svg)](http://www.apache.org/licenses/LICENSE-2.0)
[![Documentation badge](https://readthedocs.org/projects/fiware-orion/badge/?version=latest)](http://openvidu.io/docs/home/)
[![Docker badge](https://img.shields.io/docker/pulls/openvidu/openvidu-server-kms.svg)](https://hub.docker.com/r/openvidu/openvidu-server-kms)
[![Support badge](https://img.shields.io/badge/support-sof-yellowgreen.svg)](https://groups.google.com/forum/#!forum/openvidu)
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.
[![][OpenViduLogo]](http://openvidu.io)
## Running the tutorial
openvidu-electron
===
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:
Visit [openvidu.io/docs/tutorials/openvidu-electron/](http://openvidu.io/docs/tutorials/openvidu-electron/)
```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
[OpenViduLogo]: https://secure.gravatar.com/avatar/5daba1d43042f2e4e85849733c8e5702?s=120