decentralized-video-chat/README.md

38 lines
1.5 KiB
Markdown
Raw Normal View History

2020-03-22 05:23:46 +08:00
2020-03-29 02:01:35 +08:00
# Decentralized Video Chat
[![Author](https://img.shields.io/badge/Author-ianramzy-brightgreen.svg)](https://ianramzy.com)
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
[![Donate](https://img.shields.io/badge/Donate-PayPal-brightgreen.svg)](https://paypal.me/ianramzy)
![GitHub repo size](https://img.shields.io/github/repo-size/ianramzy/decentralized-video-chat.svg)
[![Repo Link](https://img.shields.io/badge/Repo-Link-black.svg)](https://github.com/ianramzy/decentralized-video-chat)
# → https://neonchat.io
Decentralized video chat platform powered by WebRTC using Twilio STUN/TURN infrastructure.
2020-03-22 05:23:46 +08:00
# Quick start
2020-03-29 02:06:04 +08:00
* You will need to have Node.js installed, this project has been tested with Node version 10.X.X and 12.X.X but
probably works with more versions
2020-03-22 05:23:46 +08:00
* Clone this repo
```
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
```
npm install
```
2020-03-29 02:06:04 +08:00
* Create a `.env` file copying `.env.template` (You can copy the file using the command below).
2020-03-29 02:01:35 +08:00
```
cp .env.template .env
```
2020-03-29 02:06:04 +08:00
* Fill in your `Account SID` and `Auth Token` from your [Twilio console](https://www.twilio.com/console)
It takes 2 minutes to sign up for a free account.
2020-03-22 05:23:46 +08:00
* Start the server
```
npm start
```
2020-03-29 02:01:35 +08:00
* Open two browsers on your laptop and point them `localhost:3000`.
* If you want to use a client on another computer, make sure you publish your server on an HTTPS connection.
You can use a service like [ngrok](https://ngrok.com/) for that.