Giter Club home page Giter Club logo

mirotalk's Introduction

MiroTalk

๐Ÿš€ A free WebRTC browser-based video call, chat and screen sharing ๐Ÿš€


Author License: AGPLv3 Donate Repo Link Code style: prettier Gitter Discord

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

Open the app with the following supported browsers & many more...

Foo


mirotalk

Features

  • Is 100% Free and Open Source
  • No download, plug-in or login required, entirely browser based
  • Unlimited number of conference rooms without call time limitation
  • Desktop and Mobile compatible
  • Optimized Room URL Sharing (share it to your participants, wait them to join)
  • Webcam Streaming (Front - Rear for mobile)
  • Audio Streaming crystal clear
  • Screen Sharing to present documents, slides, and more...
  • File Sharing, share any files to your participants in the room
  • Select Audio Input - Output && Video source
  • Ability to set video quality up to 4K and adapt the FPS
  • Recording your Screen, Audio and Video
  • Chat with Emoji Picker & Private messages & Save the conversations
  • Simple collaborative whiteboard for the teachers
  • Share any YouTube video in real time
  • Full Screen Mode on mouse click on the Video element
  • Possibility to Change UI Themes
  • Right-click on the Video elements for more options
  • Direct peer-to-peer connection ensures the lowest latency thanks to WebRTC
  • Supports REST API (Application Programming Interface)

Demo

Room join

Quick start

  • You will need to have Node.js installed, this project has been tested with Node version 12.X and 14.X
# clone this repo
git clone https://github.com/miroslavpejic85/mirotalk.git

# mirotalk dir
cd mirotalk

# copy .env.template to .env
cp .env.template .env

# install dependencies
npm install

# start the server
npm start

Docker

# copy .env.template to .env
cp .env.template .env

# build or rebuild services
docker compose build

# create and start containers
docker compose up # -d

# stop and remove resources
docker compose down

API

The response will give you a entrypoint / Room URL for your meeting, where authorization: API_KEY_SECRET.

curl -X POST "http://localhost:3000/api/v1/meeting" -H "authorization: mirotalk_default_secret" -H "Content-Type: application/json"
curl -X POST "https://mirotalk.up.railway.app/api/v1/meeting" -H "authorization: mirotalk_default_secret" -H "Content-Type: application/json"
curl -X POST "https://mirotalk.herokuapp.com/api/v1/meeting" -H "authorization: mirotalk_default_secret" -H "Content-Type: application/json"

API Documentation

The API documentation uses swagger at http://localhost:3000/api/v1/docs. Or check it out on railway & heroku.


If you want MiroTalk to be reachable from the outside of your local network, you can use a service like ngrok (by editing the Ngrok part on .env file) or expose it directly on https or deploy it on:


Deploy on Heroku

demo https://mirotalk.herokuapp.com/

heroku-qr


Deploy on Railway

demo https://mirotalk.up.railway.app/

railway-qr


Credits

Many Thanks to:

  • ianramzy (html template)
  • vasanthv (webrtc)
  • Sajad (chat)
  • i-aryan (whiteboard)
  • fmeringdal (rest api)

From where I took inspiration for this project. โค๏ธ

Contributing

  • Pull Requests are very welcome! ๐Ÿ™‚
  • Just run prettier on all of your PRs before submitting, this can be done with the following comand:
npm run lint
  • For communication we use gitter or discord chats which can be found here:

Gitter Discord

License

AGPLv3


Made with โค๏ธ by Miroslav Pejic

mirotalk's People

Contributors

miroslavpejic85 avatar jaideep25 avatar ni5arga avatar rudrathedev avatar tranchitella avatar mmguero avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.