db0c6a24ce
* Edits on package.json #45 Add prepublishOnly https://docs.npmjs.com/misc/scripts Add bin https://docs.npmjs.com/files/package.json#bin * `chmod +x src/index.js` This is required because file is run from package.json:7 bin * Add npm install documentation #45 * Add npm badge * Styling change by npm in package.json * Add warning on npm global install https://github.com/jeremija/peer-calls/pull/48#issuecomment-437192240
79 lines
1.6 KiB
Markdown
79 lines
1.6 KiB
Markdown
# Peer Calls
|
|
|
|
[](https://travis-ci.org/jeremija/peer-calls) [](https://www.npmjs.com/package/peer-calls)
|
|
|
|
WebRTC peer to peer calls for everyone. See it live in action at
|
|
[peercalls.com](https://peercalls.com).
|
|
|
|
Work in progress.
|
|
|
|
# Requirements
|
|
- Node.js 8 [https://nodejs.org/en/](https://nodejs.org/en/)
|
|
|
|
# Installation & Running
|
|
|
|
## From npm
|
|
|
|
create directory `./peer-calls` and copy [config/default.json](https://raw.githubusercontent.com/jeremija/peer-calls/master/config/default.json) into it.
|
|
|
|
```bash
|
|
npm install --global peer-calls
|
|
|
|
env NODE_CONFIG_DIR=./peer-calls peercalls
|
|
```
|
|
|
|
> :warning: Using `--global` is not advised in server environments. [*](https://github.com/jeremija/peer-calls/pull/48)
|
|
|
|
## From git source
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
http://<your_ip_or_localhost>:3000
|
|
|
|
# Testing
|
|
|
|
```bash
|
|
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 (untested).
|
|
|
|
For more details, see here:
|
|
|
|
- http://caniuse.com/#feat=rtcpeerconnection
|
|
- http://caniuse.com/#search=getUserMedia
|
|
|
|
# Contributing
|
|
|
|
See [Contributing](CONTRIBUTING.md) section.
|
|
|
|
# License
|
|
|
|
[MIT](LICENSE)
|