{"id":13403037,"url":"https://github.com/oslabs-beta/ReactRTC","last_synced_at":"2025-03-14T08:31:24.752Z","repository":{"id":35602089,"uuid":"217636811","full_name":"oslabs-beta/ReactRTC","owner":"oslabs-beta","description":"NPM package that simplifies set-up of WebRTC as importable React components","archived":false,"fork":false,"pushed_at":"2022-12-11T14:18:19.000Z","size":24941,"stargazers_count":270,"open_issues_count":23,"forks_count":25,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-12-31T13:04:56.766Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oslabs-beta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-26T00:56:15.000Z","updated_at":"2024-07-20T11:07:29.000Z","dependencies_parsed_at":"2023-01-16T01:00:28.801Z","dependency_job_id":null,"html_url":"https://github.com/oslabs-beta/ReactRTC","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FReactRTC","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FReactRTC/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FReactRTC/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FReactRTC/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oslabs-beta","download_url":"https://codeload.github.com/oslabs-beta/ReactRTC/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243547352,"owners_count":20308690,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T19:01:24.542Z","updated_at":"2025-03-14T08:31:24.727Z","avatar_url":"https://github.com/oslabs-beta.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/oslabs-beta/ReactRTC/blob/master/project_assets/ReactRTC2.png\" alt=\"ReactRTC\" width=\"400\"\u003e\u003c/a\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/div\u003e\n\n\nReactRTC-beta is a JS library that brings the real-time communication capabilities of WebRTC into React applications. \n\nReactRTC simplifies the implementation of WebRTC by providing developers with a customizable react component and signalling server module for the back-end.\n\n\u003ch2\u003eFeatures\u003c/h2\u003e\n\n- Live video \u0026 audio streaming capabilities. \n- GUI interface providing key user functionality.\n- Signalling server module utilizing websockets.\n- Multi-user support through the implementation of server side rooms.\n\n\u003ch2\u003eInstalling\u003c/h2\u003e\n\u003cbr\u003e\n\u003cpre\u003enpm install react-rtc-real\u003c/pre\u003e\n\nReactRTC runs on React^16.11.0 and requires the following dependencies to operate. \n\nImport the `\u003cRTCMesh /\u003e` component into your React application to begin.\n\u003cbr\u003e\n\u003cpre\u003eimport RTCMesh from 'react-rtc-real';\nrequire('react-rtc-real/assets/index.css');\u003c/pre\u003e\n\nTo set the URL of the signaling server pass the URL into props like so.\n\u003cbr\u003e\n`\u003cRTCMesh URL=*url goes here* /\u003e`\n\nURL must be a websocket, pre-pended with wss://\n\u003cbr\u003e\n![Import Demo](https://github.com/oslabs-beta/ReactRTC/blob/master/project_assets/Demo-import.png?raw=true)\n\u003cbr\u003e\n\u003cbr\u003e\n*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*\n\nTo set up Signaling Server to find remote client, import to your server.js file.\nThere should only be 3 lines of code added to your server.js file, numbered below.\n(assuming Node/Express is being used):\n\u003cpre\u003e[1]: const SignalServer = require('react-rtc-real/server/SignalServer.js'); \u003c/pre\u003e\n\nFind your server instance, which will be invoking the http.createServer(), for example:\n\u003cpre\u003e const server = https.createServer(app); \u003c/pre\u003e\n\nCreate the Signal Server instance and connect to it:\n\u003cpre\u003e[2]: const signal = new SignalServer({ server });\n[3]: signal.connect(); \u003c/pre\u003e\n\nMake sure your server instance is listening for the PORT number, like so:\n\u003cpre\u003eserver.listen(3000, () =\u003e console.log('listening on 3000'));\u003c/pre\u003e\n\nChoose your preferred tech for exposing a PORT for Signal Server.\n\nUsing ngrok: https://ngrok.com/download\n\nUse the same PORT number and call in terminal (ie. 3000):\n\u003cpre\u003e ./ngrok http 3000 \u003c/pre\u003e\n\nUsing LocalTunnel: \u003cpre\u003enpm install -g localtunnel\u003c/pre\u003e\n\u003cpre\u003elt --port 3000 --subdomain chooseUniqueName\u003c/pre\u003e\n\n\u003cbr\u003e\n\n![Signal Demo](https://github.com/oslabs-beta/ReactRTC/blob/master/project_assets/Demo-signal.png?raw=true)\n\n\u003cbr\u003e\n\u003cbr\u003e\n*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*\n\n\u003cbr\u003e\nDemo\n\u003cbr\u003e\n\n![Use Gif](https://github.com/oslabs-beta/ReactRTC/blob/master/project_assets/demo-use.gif?raw=true)\n\n\u003cbr\u003e\n\u003cbr\u003e\n*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*\n\n\u003ch2\u003eAuthors\u003c/h2\u003e\n\n- Michael Romero\n- Joseph Wolensky\n- Diane Wu\n- Edwin Lin\n\n\u003ch2\u003eLicenses\u003c/h2\u003e\n\nThis project is licensed under the MIT License - see the LICENSE file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foslabs-beta%2FReactRTC","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foslabs-beta%2FReactRTC","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foslabs-beta%2FReactRTC/lists"}