The streaming torrent app. For Mac, Windows, and Linux.
Download the latest version of WebTorrent Desktop from the official website:
Download specific installer files from the GitHub releases page.
Use Homebrew-Cask to install from the command line:
$ brew cask install webtorrent
Try the (unstable) development version by cloning the Git repository. See the "How to Contribute" instructions.
How to Contribute
Get the code
$ git clone https://github.com/webtorrent/webtorrent-desktop.git $ cd webtorrent-desktop $ npm install
Run the app
$ npm start
Watch the code
Restart the app automatically every time code changes. Useful during development.
$ npm run watch
$ npm test
Run integration tests
$ npm run test-integration
The integration tests use Spectron and Tape. They click through the app, taking screenshots and comparing each one to a reference. Why screenshots?
- Ad-hoc checking makes the tests a lot more work to write
- Even diffing the whole HTML is not as thorough as screenshot diffing. For example, it wouldn't catch an bug where hitting ESC from a video doesn't correctly restore window size.
- Chrome's own integration tests use screenshot diffing iirc
- Small UI changes will break a few tests, but the fix is as easy as deleting the offending screenshots and running the tests, which will recreate them with the new look.
- The resulting Github PR will then show, pixel by pixel, the exact UI changes that were made! See https://github.com/blog/817-behold-image-view-modes
For MacOS, you'll need a Retina screen for the integration tests to pass. Your screen should have the same resolution as a 2016 12" Macbook.
For Windows, you'll need Windows 10 with a 1366x768 screen.
When running integration tests, keep the mouse on the edge of the screen and don't touch the mouse or keyboard while the tests are running.
Package the app
Builds app binaries for Mac, Linux, and Windows.
$ npm run package
To build for one platform:
$ npm run package -- [platform] [options]
The following optional arguments are available:
--sign- Sign the application (Mac, Windows)
--package=[type]- Package single output type.
deb- Debian package
zip- Linux zip file
dmg- Mac disk image
exe- Windows installer
portable- Windows portable app
all- All platforms (default)
Note: Even with the
--package option, the auto-update files (.nupkg for Windows,
-darwin.zip for Mac) will always be produced.
Windows build notes
The Windows app can be packaged from any platform.
Note: Windows code signing only works from Windows, for now.
brew install wine
(Requires the Homebrew package manager.)
Mac build notes
The Mac app can only be packaged from macOS.
Linux build notes
The Linux app can be packaged from any platform.
Recommended readings to start working in the app
React.js (Framework to work with Frontend UI): https://reactjs.org/docs/getting-started.html
Material UI (React components that implement Google's Material Design.): https://material-ui.com/getting-started
WebTorrent Desktop collects some basic usage stats to help us make the app better. For example, we track how well the play button works. How often does it succeed? Time out? Show a missing codec error?
The app never sends any personally identifying information, nor does it track which torrents you add.
MIT. Copyright (c) WebTorrent, LLC.