{"id":13394684,"url":"https://github.com/webtorrent/webtorrent-desktop","last_synced_at":"2025-05-14T02:08:42.055Z","repository":{"id":31451756,"uuid":"35015575","full_name":"webtorrent/webtorrent-desktop","owner":"webtorrent","description":"❤️ Streaming torrent app for Mac, Windows, and Linux","archived":false,"fork":false,"pushed_at":"2025-05-01T17:29:52.000Z","size":176840,"stargazers_count":9839,"open_issues_count":77,"forks_count":1021,"subscribers_count":243,"default_branch":"master","last_synced_at":"2025-05-01T18:34:29.567Z","etag":null,"topics":["bittorrent","electron","hacktoberfest","javascript","linux","macos","nodejs","p2p","streaming","webrtc","webtorrent","windows"],"latest_commit_sha":null,"homepage":"https://webtorrent.io/desktop","language":"JavaScript","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/webtorrent.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["webtorrent","feross"]}},"created_at":"2015-05-04T05:21:35.000Z","updated_at":"2025-05-01T17:29:55.000Z","dependencies_parsed_at":"2024-01-17T22:46:37.297Z","dependency_job_id":"c98add5b-785b-48fc-9f80-d3a1cc15f8e5","html_url":"https://github.com/webtorrent/webtorrent-desktop","commit_stats":null,"previous_names":["feross/webtorrent-desktop","feross/webtorrent-app"],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtorrent%2Fwebtorrent-desktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtorrent%2Fwebtorrent-desktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtorrent%2Fwebtorrent-desktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtorrent%2Fwebtorrent-desktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webtorrent","download_url":"https://codeload.github.com/webtorrent/webtorrent-desktop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254053182,"owners_count":22006717,"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":["bittorrent","electron","hacktoberfest","javascript","linux","macos","nodejs","p2p","streaming","webrtc","webtorrent","windows"],"created_at":"2024-07-30T17:01:28.120Z","updated_at":"2025-05-14T02:08:37.040Z","avatar_url":"https://github.com/webtorrent.png","language":"JavaScript","funding_links":["https://github.com/sponsors/webtorrent","https://github.com/sponsors/feross"],"categories":["JavaScript","Applications","网络服务","electron","Web Frontend"],"sub_categories":["Sharing Files","Video","网络服务_其他","🎬 Video (19)","JS Libraries \u0026 Utilities"],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://webtorrent.io\"\u003e\n    \u003cimg src=\"https://webtorrent.io/img/WebTorrent.png\" alt=\"WebTorrent\" width=\"200\"\u003e\n  \u003c/a\u003e\n  \u003cbr\u003e\n  WebTorrent Desktop\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003eThe streaming torrent app. For Mac, Windows, and Linux.\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://discord.gg/cnXkm4Z\"\u003e\u003cimg src=\"https://img.shields.io/discord/612575111718895616\" alt=\"discord\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/webtorrent/webtorrent-desktop/actions/workflows/ci.yml\"\u003e\u003cimg src=\"https://github.com/webtorrent/webtorrent-desktop/actions/workflows/ci.yml/badge.svg\" alt=\"GitHub CI action\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/webtorrent/webtorrent-desktop/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/release/webtorrent/webtorrent-desktop.svg\" alt=\"github release version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/webtorrent/webtorrent-desktop/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/downloads/webtorrent/webtorrent-desktop/total.svg\" alt=\"github release downloads\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://standardjs.com\"\u003e\u003cimg src=\"https://img.shields.io/badge/code_style-standard-brightgreen.svg\" alt=\"Standard - JavaScript Style Guide\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Install\n\n### Recommended Install\n\nDownload the latest version of WebTorrent Desktop from\n[the official website](https://webtorrent.io/desktop/):\n\n### [✨ Download WebTorrent Desktop ✨](https://webtorrent.io/desktop/)\n\n### Advanced Install\n\n- Download specific installer files from the [GitHub releases](https://github.com/webtorrent/webtorrent-desktop/releases) page.\n\n- Use [Homebrew-Cask](https://github.com/caskroom/homebrew-cask) to install from the command line:\n\n  ```\n  $ brew install --cask webtorrent\n  ```\n\n- Try the (unstable) development version by cloning the Git repository. See the\n  [\"How to Contribute\"](#how-to-contribute) instructions.\n\n## Screenshots\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://webtorrent.io/img/screenshot-player3.png\" alt=\"screenshot\" align=\"center\"\u003e\n  \u003cimg src=\"https://webtorrent.io/img/screenshot-main.png\" width=\"612\" height=\"749\" alt=\"screenshot\" align=\"center\"\u003e\n\u003c/p\u003e\n\n## How to Contribute\n\n### Get the code\n\n```\n$ git clone https://github.com/webtorrent/webtorrent-desktop.git\n$ cd webtorrent-desktop\n$ npm install\n```\n\n### Run the app\n\n```\n$ npm start\n```\n\n### Watch the code\n\nRestart the app automatically every time code changes. Useful during development.\n\n```\n$ npm run watch\n```\n\n### Run linters\n\n```\n$ npm test\n```\n\n### Run integration tests\n\n```\n$ npm run test-integration\n```\n\nThe integration tests use Spectron and Tape. They click through the app, taking screenshots and\ncomparing each one to a reference. Why screenshots?\n\n* Ad-hoc checking makes the tests a lot more work to write\n* Even diffing the whole HTML is not as thorough as screenshot diffing. For example, it wouldn't\n  catch an bug where hitting ESC from a video doesn't correctly restore window size.\n* Chrome's own integration tests use screenshot diffing iirc\n* Small UI changes will break a few tests, but the fix is as easy as deleting the offending\n  screenshots and running the tests, which will recreate them with the new look.\n* The resulting Github PR will then show, pixel by pixel, the exact UI changes that were made! See\n  https://github.com/blog/817-behold-image-view-modes\n\nFor MacOS, you'll need a Retina screen for the integration tests to pass. Your screen should have\nthe same resolution as a 2018 MacBook Pro 13\".\n\nFor Windows, you'll need Windows 10 with a 1366x768 screen.\n\nWhen running integration tests, keep the mouse on the edge of the screen and don't touch the mouse\nor keyboard while the tests are running.\n\n### Package the app\n\nBuilds app binaries for Mac, Linux, and Windows.\n\n```\n$ npm run package\n```\n\nTo build for one platform:\n\n```\n$ npm run package -- [platform] [options]\n```\n\nWhere `[platform]` is `darwin`, `linux`, `win32`, or `all` (default).\n\nThe following optional arguments are available:\n\n- `--sign` - Sign the application (Mac, Windows)\n- `--package=[type]` - Package single output type.\n   - `deb` - Debian package\n   - `rpm` - RedHat package\n   - `zip` - Linux zip file\n   - `dmg` - Mac disk image\n   - `exe` - Windows installer\n   - `portable` - Windows portable app\n   - `all` - All platforms (default)\n\nNote: Even with the `--package` option, the auto-update files (.nupkg for Windows,\n-darwin.zip for Mac) will always be produced.\n\n#### Windows build notes\n\nThe Windows app can be packaged from **any** platform.\n\nNote: Windows code signing only works from **Windows**, for now.\n\nNote: To package the Windows app from non-Windows platforms,\n[Wine](https://www.winehq.org/) and [Mono](https://www.mono-project.com/) need\nto be installed. For example on Mac, first install\n[XQuartz](http://www.xquartz.org/), then run:\n\n```\n$ brew install wine mono\n```\n\n(Requires the [Homebrew](http://brew.sh/) package manager.)\n\n#### Mac build notes\n\nThe Mac app can only be packaged from **macOS**.\n\n#### Linux build notes\n\nThe Linux app can be packaged from **any** platform.\n\nIf packaging from Mac, install system dependencies with Homebrew by running:\n\n```\nnpm run install-system-deps\n```\n#### Recommended readings to start working in the app\n\nElectron (Framework to make native apps for Windows, OSX and Linux in Javascript):\nhttps://electronjs.org/docs/tutorial/quick-start\n\nReact.js (Framework to work with Frontend UI):\nhttps://reactjs.org/docs/getting-started.html\n\nMaterial UI (React components that implement Google's Material Design.):\nhttps://material-ui.com/getting-started/installation\n\n### Privacy\n\nWebTorrent Desktop collects some basic usage stats to help us make the app better.\nFor example, we track how well the play button works. How often does it succeed?\nTime out? Show a missing codec error?\n\nThe app never sends any personally identifying information, nor does it track which\ntorrents you add.\n\n## License\n\nMIT. Copyright (c) [WebTorrent, LLC](https://webtorrent.io).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebtorrent%2Fwebtorrent-desktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebtorrent%2Fwebtorrent-desktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebtorrent%2Fwebtorrent-desktop/lists"}