Skip to content

Latest commit

 

History

History
127 lines (85 loc) · 4.08 KB

README.md

File metadata and controls

127 lines (85 loc) · 4.08 KB
Raw

mirotalk

🚀 A free WebRTC browser-based video call, chat and screen sharing 🚀


Author License: CC-NC Donate Repo Link code style: prettier Gitter

Powered by WebRTC using google Stun and numb Turn. mirotalk provides video quality and latency not available with traditional technology.

Open the app in one of following supported browser

Foo

https://mirotalk.herokuapp.com/


mirotalk

Features

  • Is 100% Free and Open Source
  • No download, plug-in or login required, entirely browser based
  • Unlimited users, without time limitation
  • Room Url Sharing (share it to your participants, wait them to join)
  • WebCam Streaming (Front - Rear for mobile)
  • Audio Streaming
  • Screen Sharing to present documents, slides, and more...
  • Select Audio Input - Output && Video source
  • Recording your Screen, Audio and Video
  • Chat & Emoji Picker & Save the conversations
  • Full Screen Mode on click
  • Possibility to Change UI Themes
  • Right click on Video elements for more options
  • Direct peer-to-peer connection ensures lowest latency thanks to webrtc

Demo

  • Open https://mirotalk.herokuapp.com/newcall
  • Pick your personal Room name and Join To Room
  • Allow to use the camera and microphone
  • Share the Room URL and Wait someone to join for video conference

Room name

Quick start

  • You will need to have Node.js installed, this project has been tested with Node version 12.X
  • Clone this repo
git clone [email protected]:miroslavpejic85/mirotalk.git
cd mirotalk

Setup Turn and Ngrok

  • Copy .env.template to .env
cp .env.template .env

Turn

  • Create an account on http://numb.viagenie.ca
  • Get your Account USERNAME and PASSWORD
  • Fill in your credentials in the .env file
  • Set TURN_ENABLED=true, if you want enable the Turn Server.

Ngrok

  • Get started for free https://ngrok.com/
  • Fill in your authtoken in the .env file
  • Set NGROK_ENABLED=true, if you want to expose the server using the https tunnel, starting it from your local pc.

Install dependencies

npm install

Start the server

npm start
  • Open http://localhost:3000 in browser
  • If you want to use a client on another computer/network, make sure you publish your server on an HTTPS connection. You can use a service like ngrok Or deploy it on heroku.

Credits

Many Thanks to:

  • ianramzy (html template)
  • vasanthv (webrtc)
  • Sajad (chat)

from where I taked inspiration for this project. ❤️

Contributing

  • Pull Requests are welcome! 🙂
  • Please run prettier on all of your PRs before submitting, this can be done with prettier --write mirotalk/
  • For communication we use Gitter Chat which can be found here:

Gitter

qr

Made with ❤️ by Miroslav Pejic