{"id":13639738,"url":"https://github.com/urbit/urbit-webrtc","last_synced_at":"2025-04-10T01:31:34.796Z","repository":{"id":42174596,"uuid":"332307081","full_name":"urbit/urbit-webrtc","owner":"urbit","description":"WebRTC integration for Urbit: https://grants.urbit.org/proposals/21131866-webrtc-gall-agent-and-external-app","archived":false,"fork":false,"pushed_at":"2022-12-24T20:49:38.000Z","size":17304,"stargazers_count":34,"open_issues_count":6,"forks_count":10,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-03-24T14:21:25.262Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/urbit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-23T21:01:09.000Z","updated_at":"2024-08-31T23:03:23.000Z","dependencies_parsed_at":"2023-01-30T21:15:37.818Z","dependency_job_id":null,"html_url":"https://github.com/urbit/urbit-webrtc","commit_stats":null,"previous_names":["black-river-software/urbit-webrtc"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbit%2Furbit-webrtc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbit%2Furbit-webrtc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbit%2Furbit-webrtc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbit%2Furbit-webrtc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/urbit","download_url":"https://codeload.github.com/urbit/urbit-webrtc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248140379,"owners_count":21054290,"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-08-02T01:01:04.100Z","updated_at":"2025-04-10T01:31:29.774Z","avatar_url":"https://github.com/urbit.png","language":"TypeScript","funding_links":[],"categories":["Archive"],"sub_categories":["Tools"],"readme":"# urbit-webrtc\nWebRTC integration for Urbit: https://grants.urbit.org/proposals/21131866-webrtc-gall-agent-and-external-app\n\n[![awesome urbit badge](https://img.shields.io/badge/~-awesome%20urbit-lightgrey)](https://github.com/urbit/awesome-urbit)\n\n## Packages\n- `icepond`: Gall agent and marks for ICE server acquisition\n- `icepond-js`: Javascript library for fetching ICE servers over airlock from icepond\n- `icepond-test`: React app demonstrating icepond\n- `switchboard`: Gall agent and marks for signalling WebRTC peer connections\n- `switchboard-js` Javascript library for setting up WebRTC peer connections via Urbit airlock to switchboard\n- `urchatfm`: React app demonstrating peer-to-peer ephemeral chat over WebRTC, signalled over Urbit\n\n## Design\nSee [DESIGN.md](DESIGN.md)\n\n## Getting Started\n\nRun `npm i \u0026\u0026 npm run bootstrap` to get started. This project uses [lerna](https://lerna.js.org/) to manage the `switchboard-js` and `icepond-js` packages. Add a `.env.local` file to the `urchatfm` directory with the following entry `VITE_SHIP_URL=https://yourshipurl.com` replacing \"https://yourshipurl.com\" with your actual url.\n\nWhenever working you can simply run `npm run dev` from the root directory which will simultaneously watch both packages for any changes and run the development server for `urchatfm`. It will proxy requests to the ship url added above. That ship will have to have `urchatfm` installed.\n\nWhen it's time to release `urchatfm` running `npm run build` will build all packages and `urchatfm` itself. The resulting `urchatfm/dist` folder is then ready to be made into a glob.\n\nIf either `switchboard-js` or `icepond-js` are updated, they can be published to npm using `npm run publish`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furbit%2Furbit-webrtc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Furbit%2Furbit-webrtc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furbit%2Furbit-webrtc/lists"}