decentralized-video-chat/README.md

56 lines
1.7 KiB
Markdown
Raw Normal View History

2020-04-03 09:24:22 +08:00
# Zipcall - Decentralized Video Chat
2020-03-29 02:01:35 +08:00
[![Author](https://img.shields.io/badge/Author-ianramzy-brightgreen.svg)](https://ianramzy.com)
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
2020-03-29 02:01:35 +08:00
[![Donate](https://img.shields.io/badge/Donate-PayPal-brightgreen.svg)](https://paypal.me/ianramzy)
[![Repo Link](https://img.shields.io/badge/Repo-Link-black.svg)](https://github.com/ianramzy/decentralized-video-chat)
2020-04-06 22:54:58 +08:00
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?)](https://github.com/prettier/prettier)
2020-04-03 09:24:22 +08:00
# https://zipcall.io
2020-03-29 02:01:35 +08:00
Decentralized video chat platform powered by WebRTC using Twilio STUN/TURN infrastructure.
2020-04-03 09:24:22 +08:00
Zipcall provides video quality and latency simply not available with traditional
2020-03-29 03:51:27 +08:00
technology.
2020-03-22 05:23:46 +08:00
2020-04-06 22:19:11 +08:00
![screenshot](public/images/readmecall.png "Video Calling")
2020-03-29 03:51:27 +08:00
## Features
2020-04-06 22:19:11 +08:00
<img align="right" width="400" height="auto" src="public/images/preview.gif">
- Screen sharing
2020-04-06 22:01:27 +08:00
- Picture in picture
- Live captions
- Text chat
- Auto-scaling video quality
- No download required, entirely browser based
- Direct peer to peer connection ensures lowest latency
- Single use disposable chat rooms
2020-03-29 03:51:27 +08:00
## Quick start
- You will need to have Node.js installed, this project has been tested with Node version 10.X and 12.X
- Clone this repo
2020-03-22 05:23:46 +08:00
```
2020-03-29 02:01:35 +08:00
git clone https://github.com/ianramzy/decentralized-video-chat
cd decentralized-video-chat
2020-03-22 05:23:46 +08:00
```
- Install dependencies
2020-03-22 05:23:46 +08:00
```
npm install
```
- Start the server
2020-03-22 05:23:46 +08:00
```
npm start
```
2020-03-29 02:31:00 +08:00
- Open `localhost:3000` in Chrome or Firefox.
- 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](https://ngrok.com/) for that.