peer-calls/README.md

2.0 KiB

Peer Calls

Build Status NPM Package

WebRTC peer to peer calls for everyone. See it live in action at peercalls.com.

Work in progress.

Requirements

Installation & Running

From npm

Local install

npm install peer-calls
mkdir config/
curl -o config/local.json https://raw.githubusercontent.com/jeremija/peer-calls/master/config/default.json
./node_modules/.bin/peer-calls

create directory ./peer-calls and copy config/default.json into it.

npm install --global peer-calls

env NODE_CONFIG_DIR=./peer-calls peercalls

⚠️ Using --global is not advised in server environments. *

From git source

git clone https://github.com/jeremija/peer-calls.git
cd peer-calls
npm install

# for production
npm run build
npm start

# for development
npm run start:watch

To run a development version, type:

If you successfully completed the above steps, your commandline/terminal should show that your node server is listening.

On your other machine or mobile device open the url: http://<your_ip_or_localhost>:3000

Testing

npm install
npm test

Browser Support

Tested on Firefox and Chrome, including mobile versions.

Does not work on iOS 10, but should work on iOS 11 - would appreciate feedback!

For more details, see here:

Contributing

See Contributing section.

License

MIT