lbry-desktop/README.md
2018-02-06 12:28:55 -08:00

3.3 KiB

LBRY App

dependencies

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.

App screenshot

Installing

We provide installers for Windows, macOS, and Debian-based Linux.

Windows macOS Linux
Latest Stable Release Download Download Download
Latest Prerelease Download Download Download

Our releases page also contains the latest release, pre-releases, and past builds.

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

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

One-time Setup

  1. Clone this repo
  2. DEPS=true ./build.sh

This will download and install the LBRY app and its dependencies, including the LBRY daemon and command line utilities like node and yarn. The LBRY app requires Node >= 6; if you have an earlier version of Node installed and want to keep it, you can use nvm to switch back and forth.

Arch Linux and Other Non-Debian Distributions

Running the build script with DEPS=true triggers a bash script with apt-get specific commands. If you are using a distribution without apt-get, try running the script as:

./build.sh

You may also have to install the package libsecret if it is not already installed.

Running

The app can be run from the sources using the following command:

yarn dev

On Windows

One-time Setup

Download the lbry daemon and CLI binaries and place them in static\daemon.

Build

Run yarn build.

We use electron-builder to create distributable packages.

Contributing

Please read our contributing manual for details on how to develop for the project and the process of submitting pull requests.

Internationalization

If you want to help to translate the lbry-app, you can copy the en.json file in /dist/locales/ and modify the values while leaving the keys as their original English strings. An example for this would be: "Skip": "Überspringen", Translations should automatically show up in options.

License

MIT © LBRY