Skip to content

Latest commit

 

History

History
138 lines (87 loc) · 3.47 KB

README.md

File metadata and controls

138 lines (87 loc) · 3.47 KB
Raw

Call-Me

This project enables easy one-to-one video calls directly from your web browser using WebRTC technology.

callme

Getting Started

Overview

This project allows you to:

  • Sign in with a username.
  • Make video calls by entering the recipient's username.
  • Toggle the visibility of your video feed.
  • Switch between cameras.
  • Enable/Disable your video.
  • Enable/Disable your audio.
  • Hang up the call when finished.
  • Use a REST API to retrieve a list of all connected users.

Quick Start

  • Using NodeJs

nodejs

Install Node.js and npm

# Clone this repo
git clone https://github.com/miroslavpejic85/call-me.git

# Go to to dir call-me
cd call-me

# Copy .env.template to .env
cp .env.template .env

# Install dependencies
npm install

# Start the application
npm start

  • Using Docker

docker

Install docker engine and docker compose

# Clone this repo
git clone https://github.com/miroslavpejic85/call-me.git

# Go to to dir call-me
cd call-me

# Copy .env.template to .env
cp .env.template .env

# Get official image from Docker Hub
docker-compose pull

# Create and start containers
docker-compose up

  1. Open your browser and visit http://localhost:8000.

  2. Sign in with your username.

  3. Enter the recipient's username and click Call.

  4. Enjoy your one-to-one video call.

Click to Call

Allows a user to join the room as a user1

Lets the user2 join the room and initiate a call to the user1

Fast Integration

iframe

Easily integrate Call-Me into your website or application with a simple iframe. Just add the following code to your project:

<iframe
    allow="camera; microphone; fullscreen; autoplay"
    src="https://cme.mirotalk.com/"
    style="width: 100vw; height: 100vh; border: 0px;"
></iframe>

API

Get all connected users

# Get all connected users
curl -X GET "http://localhost:8000/api/v1/users" -H "authorization: call_me_api_key_secret" -H "Content-Type: application/json"
curl -X GET "https://cme.mirotalk.com/api/v1/users" -H "authorization: call_me_api_key_secret" -H "Content-Type: application/json"

# Generate call links for connected users to call
curl -X GET "http://localhost:8000/api/v1/connected?user=call-me" -H "authorization: call_me_api_key_secret" -H "Content-Type: application/json"
curl -X GET "https://cme.mirotalk.com/api/v1/connected?user=call-me" -H "authorization: call_me_api_key_secret" -H "Content-Type: application/json"

Docs: http://localhost:8000/api/v1/docs/ or you can check it out live in prod here.

Self-Hosting

To install this on your VPS, VDS, or personal server, please follow the instructions in the self-hosting documentation.