2017-02-20 21:50:06 +01:00
|
|
|
# LBRY App
|
2017-01-16 20:06:53 +01:00
|
|
|
|
2018-01-29 18:19:42 +01:00
|
|
|
[](https://david-dm.org/lbryio/lbry-app)
|
|
|
|
|
|
2017-12-28 18:36:48 +01:00
|
|
|
The LBRY app 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-12-28 18:36:48 +01:00
|
|
|
|
2017-06-02 00:24:20 +02:00
|
|
|
|
2017-02-21 19:10:20 +01:00
|
|
|
## Installing
|
2017-01-18 17:32:01 +01:00
|
|
|
|
2017-03-13 16:37:49 +01:00
|
|
|
We provide installers for Windows, macOS, and Debian-based Linux.
|
|
|
|
|
|
2017-12-28 18:36:48 +01:00
|
|
|
| | Windows | macOS | Linux |
|
|
|
|
|
| --------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
|
|
|
|
| Latest Stable Release | [Download](https://lbry.io/get/lbry.exe) | [Download](https://lbry.io/get/lbry.dmg) | [Download](https://lbry.io/get/lbry.deb) |
|
|
|
|
|
| Latest Prerelease | [Download](https://lbry.io/get/lbry.pre.exe) | [Download](https://lbry.io/get/lbry.pre.dmg) | [Download](https://lbry.io/get/lbry.pre.deb) |
|
2017-05-19 16:30:13 +02:00
|
|
|
|
2017-12-28 18:36:48 +01:00
|
|
|
Our [releases page](https://github.com/lbryio/lbry-app/releases/latest) also contains the latest
|
|
|
|
|
release, pre-releases, and past builds.
|
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-12-28 18:36:48 +01:00
|
|
|
## 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
|
|
|
|
|
|
|
|
|
|
* [Git](https://git-scm.com/downloads)
|
|
|
|
|
* [Node.js](https://nodejs.org/en/download/)
|
|
|
|
|
* [Yarn](https://yarnpkg.com/en/docs/install)
|
2017-01-16 20:06:53 +01:00
|
|
|
|
2017-06-02 00:20:29 +02:00
|
|
|
### One-time Setup
|
2017-01-16 20:06:53 +01:00
|
|
|
|
2017-10-27 05:30:48 +02:00
|
|
|
1. Clone this repo
|
2018-01-15 14:41:58 +01:00
|
|
|
2. `DEPS=true ./build.sh`
|
2017-10-27 05:30:48 +02:00
|
|
|
|
2017-12-28 18:36:48 +01:00
|
|
|
This will download and install the LBRY app and its dependencies, including
|
|
|
|
|
[the LBRY daemon](https://github.com/lbryio/lbry) 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](https://github.com/creationix/nvm) to switch back and forth.
|
2017-01-16 20:06:53 +01:00
|
|
|
|
2017-12-28 18:47:17 +01:00
|
|
|
#### Arch Linux and Other Non-Debian Distributions
|
|
|
|
|
|
2017-12-30 19:55:03 +01:00
|
|
|
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:
|
2017-12-28 18:47:17 +01:00
|
|
|
|
|
|
|
|
`./build.sh`
|
|
|
|
|
|
2017-12-30 19:55:03 +01:00
|
|
|
You may also have to install the package [libsecret](https://wiki.gnome.org/Projects/Libsecret) if
|
|
|
|
|
it is not already installed.
|
2017-12-28 18:47:17 +01:00
|
|
|
|
2017-12-29 03:44:12 +01:00
|
|
|
### Running
|
|
|
|
|
|
|
|
|
|
The app can be run from the sources using the following command:
|
|
|
|
|
|
|
|
|
|
`yarn dev`
|
|
|
|
|
|
2017-12-28 18:36:48 +01:00
|
|
|
### On Windows
|
2017-01-16 20:06:53 +01:00
|
|
|
|
2017-12-28 18:36:48 +01:00
|
|
|
#### One-time Setup
|
2017-02-21 19:10:20 +01:00
|
|
|
|
2018-01-08 04:57:05 +01:00
|
|
|
Download the lbry daemon and CLI [binaries](https://github.com/lbryio/lbry/releases) and place them
|
|
|
|
|
in `static\daemon`.
|
2017-09-15 01:34:55 +02:00
|
|
|
|
2017-12-20 15:48:38 +01:00
|
|
|
### Build
|
|
|
|
|
|
2017-12-28 18:36:48 +01:00
|
|
|
Run `yarn build`.
|
|
|
|
|
|
|
|
|
|
We use [electron-builder](https://github.com/electron-userland/electron-builder) to create
|
|
|
|
|
distributable packages.
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Please read [our contributing manual](CONTRIBUTING.md) for details on how to develop for the
|
|
|
|
|
project and the process of submitting pull requests.
|
2017-05-31 12:59:58 +02:00
|
|
|
|
|
|
|
|
## Internationalization
|
|
|
|
|
|
2017-12-28 18:36:48 +01:00
|
|
|
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](LICENSE)
|
