lbry-desktop/README.md

70 lines
3.4 KiB
Markdown
Raw Normal View History

2017-02-20 21:50:06 +01:00
# LBRY App
2017-01-16 20:06:53 +01:00
2018-03-23 15:12:27 +01:00
[![Build Status](https://travis-ci.org/lbryio/lbry-app.svg?branch=master)](https://travis-ci.org/lbryio/lbry-app)
[![Dependencies](https://david-dm.org/lbryio/lbry-app/status.svg)](https://david-dm.org/lbryio/lbry-app)
2018-03-25 19:47:32 +02:00
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/78b627d4f5524792adc48719835e1523)](https://www.codacy.com/app/LBRY/lbry-app?utm_source=github.com&utm_medium=referral&utm_content=lbryio/lbry-app&utm_campaign=Badge_Grade)
[![chat on Discord](https://img.shields.io/discord/362322208485277697.svg?logo=discord)](https://discord.gg/U5aRyN6)
2018-01-29 18:19:42 +01: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
2017-12-28 18:36:48 +01:00
[Electron](http://electron.atom.io/).
2017-01-16 20:06:53 +01:00
2017-12-28 18:36:48 +01:00
![App screenshot](https://lbry.io/img/lbry-ui.png)
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
2018-05-09 19:28:14 +02:00
We provide installers for Windows, macOS (v10.9 or greater), 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 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-app/releases) also contains the latest
2017-12-28 18:36:48 +01:00
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
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/)
* [Yarn](https://yarnpkg.com/en/docs/install)
* [C++ Build Tools](https://github.com/felixrieseberg/windows-build-tools) (Windows only)
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
2018-05-11 07:12:53 +02:00
1. Clone this repository: `git clone https://github.com/lbryio/lbry-app`
2. Change directories into the downloaded folder: `cd lbry-app`
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
2018-05-30 15:16:20 +02:00
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-05-11 07:12:53 +02:00
The primary contact for this project is [@seanyesmunt](https://github.com/@seanyesmunt)