LBRYCommunity/lbry-desktop
1
0
Fork 0
Code Issues 596 Pull requests 6 Projects Releases 238 Packages Wiki Activity
lbry-desktop/README.md

3.9 KiB
Raw Blame History

LBRY App

This 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.

Development on Linux and macOS

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.

Ongoing Development

Run yarn dev

This will set up a server that will automatically compile any changes made inside src\ folder and automatically reload the app without losing the state.

Build

Run yarn build

We use electron-builder to create distributable packages.

Development on Windows

Windows Dependency

  1. Download and install git from github.io (configure to use command prompt integration)
  2. Download and install npm and node from nodejs.org
  3. Download and install python 2.7 from python.org
  4. Download and Install Microsoft Visual C++ Compiler for Python 2.7 from Microsoft
  5. Download and install .NET Framework 2.0 Software Development Kit (SDK) (x64) from Microsoft (may need to extract setup.exe and install manually by running install.exe as Administrator)

One-time Setup

  1. Open command prompt as adminstrator and run the following:
npm install --global --production windows-build-tools
exit
  1. Open command prompt in the root of the project and run the following:
python -m pip install -r build\requirements.txt
npm install -g yarn
yarn install
yarn build
  1. Download the lbry daemon and cli binaries and place them in static\daemon

Ongoing Development

Run yarn dev

Build

Run yarn build

This will set up a server that will automatically compile any changes made inside src\ folder and automatically reload the app without losing the state.

Internationalization

If you want to help translating 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.