lbry-desktop/README.md

73 lines
3 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)
2018-01-29 18:19:42 +01:00
[![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
2017-02-21 19:10:20 +01:00
## Installing
2017-01-18 17:32:01 +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
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
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)
* [C++ Build Tools](https://github.com/felixrieseberg/windows-build-tools) (Only needed on Windows)
2017-01-16 20:06:53 +01:00
### Setup
2017-01-16 20:06:53 +01:00
2018-03-25 20:11:16 +02:00
1. Clone this repository
2. Run `$ yarn`
### Run
2017-12-29 03:44:12 +01:00
The app can be run from the sources using the following command:
2018-03-25 20:11:16 +02:00
`$ yarn dev`
2017-12-20 15:48:38 +01:00
### Build
Run `$ yarn build`
2017-12-28 18:36:48 +01:00
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)