9 |
10 | PeerData is a library for bidirectional peer-to-peer transfers of arbitrary data using [RTCDataChannel](https://developer.mozilla.org/pl/docs/Web/API/RTCDataChannel). Simple *WebRTC* wrapper providing data channel abstraction.
11 |
12 | [WebRTC](https://webrtc.org/) needs a messaging service to set up and maintain a *WebRTC* call.
13 |
14 | The sender and receiver *RTCPeerConnections* run in web pages on different devices, and we need a way for them to communicate metadata.
15 | For this, we use a signaling server: a server that can pass messages between *WebRTC* clients (peers).
16 |
17 | [PeerDataServer](https://github.com/vardius/peer-data-server) - An **ready to use** example of signaling server on *Node* using [socket.io](http://socket.io/).
18 |
19 | 📖 ABOUT
20 | ==================================================
21 | Contributors:
22 |
23 | * [Rafał Lorenz](https://rafallorenz.com)
24 |
25 | Want to contribute ? Feel free to send pull requests!
26 |
27 | Have problems, bugs, feature ideas?
28 | We are using the github [issue tracker](https://github.com/vardius/peer-data/issues) to manage them.
29 |
30 | ## 📚 Documentation
31 |
32 | For **documentation** (_including examples_), **visit [rafallorenz.com/peer-data](https://rafallorenz.com/peer-data)**
33 |
34 | 🚏 HOW TO USE
35 | ==================================================
36 |
37 | 1. [Chat Example](https://github.com/vardius/webrtc-chat)
38 | 2. [React Chat Example](https://github.com/vardius/react-webrtc-chat)
39 | 3. [React Hook](https://github.com/vardius/react-peer-data)
40 |
41 | ## Installation
42 | ```bash
43 | $ npm install peer-data
44 | ```
45 |
46 | ## Basic example
47 | ```typescript
48 | import PeerData, { EventDispatcher, SocketChannel } from 'peer-data';
49 |
50 | const constraints = {ordered: true};
51 | const servers = {
52 | iceServers: [
53 | {urls: "stun:stun.1.google.com:19302"}
54 | ]
55 | };
56 |
57 | const dispatcher = new EventDispatcher();
58 | const peerData = new PeerData(dispatcher, servers, constraints);
59 | const signaling = new SocketChannel(dispatcher, 'http://localhost:8080');
60 |
61 | const room = peerData.connect('test-room');
62 |
63 | room.on("participant", participant => {
64 | participant.on("message", payload => console.log("message", payload));
65 |
66 | participant.send('Hi mate! this is private message.');
67 | })
68 | ```
69 |
70 | For how to **disconnect**, **close connection** and handle errors please check [documentation](https://rafallorenz.com/peer-data/docs/client).
71 |
72 | 📜 [License](LICENSE.md)
73 | -------
74 |
75 | This package is released under the MIT license. See the complete license in the package
76 |
--------------------------------------------------------------------------------
/.github/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6 |
7 | ## Our Standards
8 |
9 | Examples of behavior that contributes to creating a positive environment include:
10 |
11 | * Using welcoming and inclusive language
12 | * Being respectful of differing viewpoints and experiences
13 | * Gracefully accepting constructive criticism
14 | * Focusing on what is best for the community
15 | * Showing empathy towards other community members
16 |
17 | Examples of unacceptable behavior by participants include:
18 |
19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances
20 | * Trolling, insulting/derogatory comments, and personal or political attacks
21 | * Public or private harassment
22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission
23 | * Other conduct which could reasonably be considered inappropriate in a professional setting
24 |
25 | ## Our Responsibilities
26 |
27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28 |
29 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30 |
31 | ## Scope
32 |
33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34 |
35 | ## Enforcement
36 |
37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at vardius@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38 |
39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40 |
41 | ## Attribution
42 |
43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44 |
45 | [homepage]: http://contributor-covenant.org
46 | [version]: http://contributor-covenant.org/version/1/4/
47 |
--------------------------------------------------------------------------------
/website/src/core/Footer.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require("react");
9 |
10 | class Footer extends React.Component {
11 | docUrl(doc, language) {
12 | const baseUrl = this.props.config.baseUrl;
13 | const docsUrl = this.props.config.docsUrl;
14 | const docsPart = `${docsUrl ? `${docsUrl}/` : ""}`;
15 | const langPart = `${language ? `${language}/` : ""}`;
16 | return `${baseUrl}${docsPart}${langPart}${doc}`;
17 | }
18 |
19 | pageUrl(doc, language) {
20 | const baseUrl = this.props.config.baseUrl;
21 | return baseUrl + (language ? `${language}/` : "") + doc;
22 | }
23 |
24 | render() {
25 | return (
26 |
95 | );
96 | }
97 | }
98 |
99 | module.exports = Footer;
100 |
--------------------------------------------------------------------------------
/examples/local-connection/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
27 |
34 | Example
28 |local connection with custom signaling channel
29 |30 | 31 | 32 |
33 |
37 |
58 |
38 |
57 |
39 |
56 |
40 |
47 |
41 |
42 |
46 |
43 |
45 | local connection
44 |
48 |
55 |
49 |
50 |
54 |
51 |
53 | remote connection
52 |