Repository files navigation

Download the latest version of WebTorrent Desktop fromthe official website:

• Download specific installer files from theGitHub releases page.

• UseHomebrew-Cask to install from the command line:

  $ brew install --cask webtorrent

• Try the (unstable) development version by cloning the Git repository. See the"How to Contribute" instructions.

$ git clone https://github.com/webtorrent/webtorrent-desktop.git$ cd webtorrent-desktop$ npm install

$ npm start

Restart the app automatically every time code changes. Useful during development.

$ npm run watch

$ npm test

$ npm run test-integration

The integration tests use Spectron and Tape. They click through the app, taking screenshots andcomparing 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'tcatch 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 offendingscreenshots 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! Seehttps://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 havethe same resolution as a 2018 MacBook Pro 13".

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 mouseor keyboard while the tests are running.

Builds app binaries for Mac, Linux, and Windows.

$ npm run package

To build for one platform:

$ npm run package -- [platform] [options]

Where[platform] isdarwin,linux,win32, orall (default).

The following optional arguments are available:

• --sign - Sign the application (Mac, Windows)
• --package=[type] - Package single output type.
  • deb - Debian package
  • rpm - RedHat 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.

The Windows app can be packaged fromany platform.

Note: Windows code signing only works fromWindows, for now.

Note: To package the Windows app from non-Windows platforms,Wine andMono needto be installed. For example on Mac, first installXQuartz, then run:

$ brew install wine mono

(Requires theHomebrew package manager.)

The Mac app can only be packaged frommacOS.

The Linux app can be packaged fromany platform.

If packaging from Mac, install system dependencies with Homebrew by running:

npm run install-system-deps

Electron (Framework to make native apps for Windows, OSX and Linux in Javascript):https://electronjs.org/docs/tutorial/quick-start

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/installation

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 whichtorrents you add.

MIT. Copyright (c)WebTorrent, LLC.