lbry-desktop/README.md
Jeremy Kauffman 8bdcaa75c8 update README
2017-06-01 18:20:29 -04:00

2 KiB

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.

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

One-time Setup

  1. Install node and npm.
  2. Check out this repo.
  3. Set up a Python virtual environment, or live on the wild side.
  4. Run ./build.sh. This builds the UI assets and puts them into app/dist. It also downloads lbry daemon.

Running

Run ./node_modules/.bin/electron app

Ongoing Development

  1. cd ui
  2. ./watch.sh

This will set up a monitor that will automatically monitor and compile any changes to JS or CSS folders inside of the ui folder. This allows you to make changes and see them immediately by reloading the app.

Packaging

We use electron-builder to create distributable packages, which is run by calling:

node_modules/.bin/build -p never

Development on Windows

This project has currently only been worked on in Linux and macOS. If you are on Windows, you can checkout out the build steps in appveyor.yml and probably figure out something from there.