2017-02-20 21:50:06 +01:00
# LBRY App
2017-01-16 20:06:53 +01:00
2017-03-09 18:31:07 +01:00
This is a graphical browser for the decentralized content marketplace provided by the [LBRY ](https://lbry.io ) protocol. It is essentially the [lbry daemon ](https://github.com/lbryio/lbry ) bundled with a UI using [Electron ](http://electron.atom.io/ ).
2017-01-16 20:06:53 +01:00
2017-02-21 19:10:20 +01:00
## Installing
2017-01-18 17:32:01 +01:00
2017-02-21 19:10:20 +01:00
Check out the [release page ](https://github.com/lbryio/lbry-app/releases/latest ) to download a binary.
2017-01-16 20:06:53 +01:00
2017-02-21 19:10:20 +01:00
To install from source or make changes to the application, continue reading below.
2017-01-16 20:06:53 +01:00
2017-02-21 19:10:20 +01:00
## Development
2017-01-16 20:06:53 +01:00
2017-02-21 19:10:20 +01:00
This repo uses submodules, so clone it using `--recursive` .
2017-01-16 20:06:53 +01:00
2017-02-20 21:50:06 +01:00
### Setup
2017-01-16 20:06:53 +01:00
2017-02-20 21:50:06 +01:00
The
2017-02-21 19:10:20 +01:00
[lbry daemon ](https://github.com/lbryio/lbry/blob/master/INSTALL.md ) needs
2017-02-20 21:50:06 +01:00
to be installed along with pyinstaller. You also need to be
able to build the lbry-web-ui, so have node, webpack, etc installed.
2017-01-16 20:06:53 +01:00
2017-02-20 21:50:06 +01:00
### Build
2017-01-16 20:06:53 +01:00
2017-02-20 21:50:06 +01:00
run `./build.sh`
2017-01-16 20:06:53 +01:00
2017-02-20 21:50:06 +01:00
This builds the UI assets and puts them into `app/dist` . It also builds `app/dist/lbrynet-daemon` .
### Run
`./node_modules/.bin/electron app`
2017-01-16 20:06:53 +01:00
2017-02-20 21:50:06 +01:00
### Package
2017-01-16 20:06:53 +01:00
2017-02-20 21:50:06 +01:00
We use [electron-builder ](https://github.com/electron-userland/electron-builder )
to create distributable packages, which is run by calling:
2017-01-16 20:06:53 +01:00
2017-02-20 21:50:06 +01:00
`node_modules/.bin/build -p never`
2017-02-21 19:10:20 +01:00
### 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 ](https://github.com/lbryio/lbry-app/blob/master/appveyor.yml ) and probably figure out something from there.
