f91d6aee84
removed /latest since that would only show the last build, but we reference "latest release, pre-releases, and past builds."
73 lines
3 KiB
Markdown
73 lines
3 KiB
Markdown
# LBRY App
|
|
|
|
[](https://travis-ci.org/lbryio/lbry-app)
|
|
[](https://david-dm.org/lbryio/lbry-app)
|
|
[](https://www.codacy.com/app/LBRY/lbry-app?utm_source=github.com&utm_medium=referral&utm_content=lbryio/lbry-app&utm_campaign=Badge_Grade)
|
|
[](https://discord.gg/U5aRyN6)
|
|
|
|
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 an UI using
|
|
[Electron](http://electron.atom.io/).
|
|
|
|
|
|
|
|
## Installing
|
|
|
|
We provide installers for Windows, macOS, and Debian-based Linux.
|
|
|
|
| | 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) |
|
|
|
|
Our [releases page](https://github.com/lbryio/lbry-app/releases) also contains the latest
|
|
release, pre-releases, and past builds.
|
|
|
|
To install from source or make changes to the application, continue reading below.
|
|
|
|
## 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)
|
|
|
|
### Setup
|
|
|
|
1. Clone this repository
|
|
2. Run `$ yarn`
|
|
|
|
### Run
|
|
|
|
The app can be run from the sources using the following command:
|
|
|
|
`$ yarn dev`
|
|
|
|
### Build
|
|
|
|
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.
|
|
|
|
## Internationalization
|
|
|
|
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)
|