lbry-desktop/README.md
2018-07-19 11:56:05 -04:00

4.9 KiB

LBRY App

Build Status Dependencies Codacy Badge chat on Discord

forthebadge

The LBRY app is a graphical browser for the decentralized content marketplace provided by the LBRY protocol. It is essentially the lbry daemon bundled with an UI using Electron.

App GIF

Install

We provide installers for Windows, macOS (v10.9 or greater), and Debian-based Linux. See community maintained builds section for alternative Linux installations.

Windows macOS Linux
Latest Stable Release Download Download Download
Latest Pre-release Download Download Download

Our releases page also contains the latest release, pre-releases, and past builds.
Note: If the deb fails to install using the Ubuntu Software Center, install manually via sudo dpkg -i <path to deb>. You'll need to run sudo apt-get install -f if this is the first time installing it to install dependencies

To install from source or make changes to the application, continue to the next section below.

Community maintained builds for Arch Linux and Flatpak are available, see below. These installs will need to be updated manually as the in-app update process only supports deb installs at this time. Note: If coming from a deb install, the directory structure is different and you'll need to migrate data.

Flatpak Arch
Latest Release FlatHub Page AUR Package
Maintainers @choofee/@iuyte @kcseb/@TimurKiyivinski

Usage

Double click the installed application to browse with the LBRY network.

Running from Source

Prerequisites

Steps

  1. Clone (or fork) this repository: git clone https://github.com/lbryio/lbry-desktop
  2. Change directories into the downloaded folder: cd lbry-desktop
  3. Install the dependencies: yarn
  4. Run the app: yarn dev

If you want to just build the app you can run yarn build. This will give you an executable inside the /dist folder. We use electron-builder to create distributable packages.

Resetting your Packages

If the app isn't building, or yarn xxx commands aren't working you may need to just reset your node_modules. To do so you can run: rm -r node_modules && yarn or del /s /q node_modules && yarn on Windows.

Contributing

Contributions to this project are welcome, encouraged, and compensated. For more details, see CONTRIBUTING.md

License

This project is MIT licensed. For the full license, see LICENSE

Security

We take security seriously. Please contact security@lbry.io regarding any security issues. Our PGP key is here if you need it.

Contact

The primary contact for this project is @seanyesmunt