| .github | ||
| .tx | ||
| build | ||
| flow-typed | ||
| src | ||
| static | ||
| .babelrc | ||
| .eslintrc.json | ||
| .flowconfig | ||
| .gitignore | ||
| .lintstagedrc.json | ||
| .prettierrc.json | ||
| .travis.yml | ||
| azure-pipelines.yml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| dangerfile.js | ||
| electron-builder.json | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| webpack.base.config.js | ||
| webpack.electron.config.js | ||
| webpack.web.config.js | ||
| yarn.lock | ||
LBRY App
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.
Install
We provide installers for Windows, macOS (v10.12.4, Sierra, or greater), and Debian-based Linux. See community maintained builds section for alternative Linux installations.
| Windows | macOS | Linux | |
|---|---|---|---|
| Latest Stable Release | Download | Download | Download |
| Latest Pre-release | Download | Download | Download |
Our releases page also contains the latest
release, pre-releases, and past builds.
Note: If the deb fails to install using the Ubuntu Software Center, install manually via sudo dpkg -i <path to deb>. You'll need to run sudo apt-get install -f if this is the first time installing it to install dependencies
To install from source or make changes to the application, continue to the next section below.
Community maintained builds for Arch Linux and Flatpak are available, see below. These installs will need to be updated manually as the in-app update process only supports Debian installs at this time. Note: If coming from a deb install, the directory structure is different and you'll need to migrate data.
| Flatpak | Arch | Raspberry Pi | |
|---|---|---|---|
| Latest Release | FlatHub Page | AUR Package | Pi Installer |
| Maintainers | @choofee/@iuyte | @kcseb/@TimurKiyivinski | @Madiator2011 |
Usage
Double click the installed application to interact with the LBRY network.
Running from Source
OUR BUILD SETUP IS UNDER ACTIVE DEVELOPMENT AS WE MAKE CHANGES TO SUPPORT ACCESSING THIS APP FROM A WEB BROWSER. CHECK THE package.json FOR STARTUP SCRIPTS. WE WILL BE BACK TO NORMAL SOON. SORRY FOR SHOUTING
If you continue to have any issues, feel free to email me at sean@lbry.io, or tweet at me https://twitter.com/seanyesmunt.
Prerequisites
- Git
- Node.js (Use Node v8 if having trouble with keytar)
- Yarn
- C++ Build Tools (Windows only, only install if having trouble with keytar)
Steps
- Clone (or fork) this repository:
git clone https://github.com/lbryio/lbry-desktop - Change directories into the downloaded folder:
cd lbry-desktop - Install the dependencies:
yarn - Compile the app and run it:
yarn compile:electron && yarn run:electron - In a different terminal window, start the dev server to reload when you make changes:
yarn dev:electron
If you want to just build the app you can run yarn build. This will give you an executable inside the /dist folder. We use electron-builder to create
distributable packages.
Resetting your Packages
If the app isn't building, or yarn xxx commands aren't working you may need to just reset your node_modules. To do so you can run: rm -r node_modules && yarn or del /s /q node_modules && yarn on Windows.
Contributing
We ❤️ contributions from everyone and contributions to this project are encouraged, and compensated. We welcome bug reports, bug fixes and feedback is always appreciated. For more details, see CONTRIBUTING.md.
License
This project is MIT licensed. For the full license, see LICENSE.
Security
We take security seriously. Please contact security@lbry.io regarding any security issues. Our PGP key is here if you need it.
Contact
The primary contact for this project is @seanyesmunt.