mirotalk/README.md

mirotalk

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

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

https://mirotalk.herokuapp.com/

Features

• RoomUrl Sharing (just click and share URL to your friends)
• WebCam (front - rear)
• Audio
• Screen Sharing
• No download required, entirely browser based
• Direct peer to peer connection ensures lowest latency

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 git@github.com:miroslavpejic85/mirotalk.git
cd mirotalk

Set up credentials

• 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

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 tunel, starting it from your local pc.

Install dependencies

npm install

Start the server

npm start

• Open http://localhost:80 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.

Demo

• Open https://mirotalk.herokuapp.com/
• Allow to use the camera and microphone
• Click the first button to copy the url and then share it
• Wait someone to join for video conference

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: