lbryio/lbry-desktop

LBRY App

This repo contains the UI code that powers the official LBRY desktop app. 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 a UI using Electron.

Table of Contents

1. Install
2. Usage
3. Running from Source
4. Contributing
5. License
6. Security
7. Contact

Install

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

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 Debian installs at this time. Note: If coming from a deb install, the directory structure is different and you'll need to migrate data.

Usage

Start the installed application to interact with the LBRY network.

Running from Source

Prerequisites

• Git
• Node.js (v16 required)
• Corepack npm i -g corepack (Included in nodejs 14 LTS, 16 LTS and 17)
• Yarn

1. Clone (or fork) this repository: git clone https://github.com/lbryio/lbry-desktop
2. Change directory into the cloned repository: cd lbry-desktop
3. If corepack is not enabled, run sudo corepack enable (the sudo is necessary for system-wide installation, if you use container, nvm etc... you might not be forced to use it)
4. Install the dependencies: yarn

Run the electron app

yarn dev

• If you want to build and launch the production 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.

If you really think something might have gone wrong, you can force your repo to clear everything that doesn't match the repo with git reset --hard HEAD && git clean -fxd && git pull -r

Contributing

We :heart: contributions from everyone and contributions to this project are encouraged, and compensated. We welcome bug reports, bug fixes and feedback is always appreciated. 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 [email protected] regarding any security issues. Our PGP key is here if you need it. Previous versions up to v0.50.2 were signed by Sean Yesmunt. New Releases are signed by Jessop Breth.

Contact

The primary contact for this project is @jessopb.