lbry-desktop/README.md

81 lines
5.1 KiB
Markdown
Raw Normal View History

2017-02-20 21:50:06 +01:00
# LBRY App
2017-01-16 20:06:53 +01:00
[![Build Status](https://travis-ci.org/lbryio/lbry-desktop.svg?branch=master)](https://travis-ci.org/lbryio/lbry-desktop)
2018-07-12 20:41:53 +02:00
[![Dependencies](https://david-dm.org/lbryio/lbry-desktop/status.svg)](https://david-dm.org/lbryio/lbry-desktop)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/78b627d4f5524792adc48719835e1523)](https://www.codacy.com/app/LBRY/lbry-desktop?utm_source=github.com&utm_medium=referral&utm_content=lbryio/lbry-desktop&utm_campaign=Badge_Grade)
[![chat on Discord](https://img.shields.io/discord/362322208485277697.svg?logo=discord)](https://chat.lbry.io)
2018-01-29 18:19:42 +01:00
2018-08-21 21:36:37 +02:00
[![forthebadge](https://forthebadge.com/images/badges/60-percent-of-the-time-works-every-time.svg)](https://forthebadge.com)
2018-07-19 17:56:05 +02:00
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
2018-03-23 15:12:27 +01:00
[lbry daemon](https://github.com/lbryio/lbry) bundled with an UI using
2018-10-09 19:00:59 +02:00
[Electron](https://electron.atom.io/).
2017-01-16 20:06:53 +01:00
2018-06-26 15:33:55 +02:00
![App GIF](https://spee.ch/7/lbry-redesign-preview.gif)
2017-06-02 00:24:20 +02:00
2018-05-11 07:12:53 +02:00
## Install
2017-01-18 17:32:01 +01:00
We provide installers for Windows, macOS (v10.9 or greater), and Debian-based Linux. See community maintained builds section for alternative Linux installations.
| | 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 Pre-release | [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
Our [releases page](https://github.com/lbryio/lbry-desktop/releases) also contains the latest
2018-07-12 16:53:05 +02:00
release, pre-releases, and past builds.
2018-06-28 03:42:39 +02:00
*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*
2017-01-16 20:06:53 +01:00
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 deb installs at this time.
*Note: If coming from a deb install, the directory structure is different and you'll need to [migrate data](https://lbry.io/faq/backup-data).*
2018-08-21 17:35:14 +02:00
| | Flatpak | Arch | Raspberry Pi |
| --------------------- | ------------------------------------------|------------------| --------------------------------------------
2018-08-21 17:48:29 +02:00
| Latest Release | [FlatHub Page](https://flathub.org/apps/details/io.lbry.lbry-app) | [AUR Package](https://aur.archlinux.org/packages/lbry-app-bin/) | [Pi Installer](https://lbrypi.com) |
2018-08-21 17:35:14 +02:00
| Maintainers | [@choofee](https://github.com/choffee)/[@iuyte](https://github.com/iuyte) | [@kcseb](https://github.com/kcseb)/[@TimurKiyivinski](https://github.com/TimurKiyivinski) |[@Madiator2011](https://github.com/kodxana)
2017-01-16 20:06:53 +01:00
2018-05-11 07:12:53 +02:00
## Usage
Double click the installed application to browse with the LBRY network.
2017-12-28 18:36:48 +01:00
2018-05-11 07:12:53 +02:00
## Running from Source
2017-12-28 18:36:48 +01:00
2018-05-11 07:12:53 +02:00
#### Prerequisites
2017-12-28 18:36:48 +01:00
* [Git](https://git-scm.com/downloads)
* [Node.js](https://nodejs.org/en/download/) (Use Node v8 if having trouble with keytar)
2017-12-28 18:36:48 +01:00
* [Yarn](https://yarnpkg.com/en/docs/install)
* [C++ Build Tools](https://github.com/felixrieseberg/windows-build-tools) (Windows only, only install if having trouble with keytar)
2017-01-16 20:06:53 +01:00
2018-05-11 07:12:53 +02:00
#### Steps
2017-01-16 20:06:53 +01:00
1. Clone (or [fork](https://help.github.com/articles/fork-a-repo/)) this repository: `git clone https://github.com/lbryio/lbry-desktop`
2. Change directories into the downloaded folder: `cd lbry-desktop`
2018-05-11 07:12:53 +02:00
3. Install the dependencies: `yarn`
4. Run the app: `yarn dev`
2018-05-11 07:12:53 +02:00
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](https://github.com/electron-userland/electron-builder) to create
2017-12-28 18:36:48 +01:00
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.
2017-12-28 18:36:48 +01:00
## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md)
2017-05-31 12:59:58 +02:00
2018-05-11 07:12:53 +02:00
## License
2017-05-31 12:59:58 +02:00
2018-05-11 07:12:53 +02:00
This project is MIT licensed. For the full license, see [LICENSE](LICENSE)
2017-12-28 18:36:48 +01:00
2018-05-11 07:12:53 +02:00
## Security
We take security seriously. Please contact security@lbry.io regarding any security issues. Our PGP key is [here](https://keybase.io/lbry/key.asc) if you need it.
## Contact
2017-12-28 18:36:48 +01:00
2018-06-18 01:45:45 +02:00
The primary contact for this project is [@seanyesmunt](https://github.com/seanyesmunt)