lbry-desktop/README.md

# LBRY App

This 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 a UI using [Electron](http://electron.atom.io/).

![App Screenshot](https://lbry.io/img/lbry-ui.png)

## 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/latest) also contains the latest release, pre-releases, and past builds.

To install from source or make changes to the application, continue reading below.

## Development

### One-time Setup

1. Install npm and node (v6 and above required, use [nvm](https://github.com/creationix/nvm/blob/master/README.md) if having trouble)
2. Install keytar and libsecret (see [keytar repository](https://github.com/atom/node-keytar) )
3. Install yarn by running: npm install -g yarn (may require elevated permissions)
4. Check out this repo.
5. Set up a Python virtual environment, or live on the wild side.
6. Run `./build.sh`. This builds the UI assets and puts them into `app/dist`. It also downloads [lbry daemon](https://github.com/lbryio/lbry/releases).

### Running

Run `./node_modules/.bin/electron app`

### Ongoing Development
1. `cd ui`
2. `./watch.sh`

This will set up a monitor that will automatically compile any changes to JS or CSS folders inside of the `ui` folder. This allows you to make changes and see them immediately by reloading the app.

### Packaging

We use [electron-builder](https://github.com/electron-userland/electron-builder)
to create distributable packages, which is run by calling:

`node_modules/.bin/build -p never`

### Development on Windows

This project has currently only been worked on in Linux and macOS. If you are on Windows, you can
checkout out the build steps in [appveyor.yml](https://github.com/lbryio/lbry-app/blob/master/.appveyor.yml) and probably figure out something from there.

## Internationalization

If you want to help translating the lbry-app, you can copy the en.json file in /app/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.
update readme 2017-02-20 14:50:06 -06:00			`# LBRY App`
initial electron app 2017-01-16 14:06:53 -05:00
switch from `lbry-web-ui` to `ui` 2017-03-09 12:31:07 -05:00			`This 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 a UI using [Electron](http://electron.atom.io/).`
initial electron app 2017-01-16 14:06:53 -05:00
add screenshot 2017-06-01 18:24:20 -04:00			`![App Screenshot](https://lbry.io/img/lbry-ui.png)`

minor readme changes 2017-02-21 13:10:20 -05:00			`## Installing`
better startup and process management 2017-01-18 10:32:01 -06:00
improve install language (copy from lbry repo) 2017-03-13 11:37:49 -04:00			`We provide installers for Windows, macOS, and Debian-based Linux.`

add prerelease link 2017-05-19 10:30:13 -04: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) \|`

improve install language (copy from lbry repo) 2017-03-13 11:37:49 -04:00
			`Our [releases page](https://github.com/lbryio/lbry-app/releases/latest) also contains the latest release, pre-releases, and past builds.`
initial electron app 2017-01-16 14:06:53 -05:00
minor readme changes 2017-02-21 13:10:20 -05:00			`To install from source or make changes to the application, continue reading below.`
initial electron app 2017-01-16 14:06:53 -05:00
minor readme changes 2017-02-21 13:10:20 -05:00			`## Development`
initial electron app 2017-01-16 14:06:53 -05:00
update README 2017-06-01 18:20:29 -04:00			`### One-time Setup`
initial electron app 2017-01-16 14:06:53 -05:00
update setup -add node /nvm link -add keytar/libsecret -add yarn Feel free to adjust directions/wording 2017-08-17 13:04:04 -04:00			`1. Install npm and node (v6 and above required, use [nvm](https://github.com/creationix/nvm/blob/master/README.md) if having trouble)`
			`2. Install keytar and libsecret (see [keytar repository](https://github.com/atom/node-keytar) )`
			`3. Install yarn by running: npm install -g yarn (may require elevated permissions)`
			`4. Check out this repo.`
			`5. Set up a Python virtual environment, or live on the wild side.`
			6. Run `./build.sh`. This builds the UI assets and puts them into `app/dist`. It also downloads [lbry daemon](https://github.com/lbryio/lbry/releases).
initial electron app 2017-01-16 14:06:53 -05:00
update README 2017-06-01 18:20:29 -04:00			`### Running`
initial electron app 2017-01-16 14:06:53 -05:00
update README 2017-06-01 18:20:29 -04:00			Run `./node_modules/.bin/electron app`
update readme 2017-02-20 14:50:06 -06:00
update README 2017-06-01 18:20:29 -04:00			`### Ongoing Development`
			1. `cd ui`
			2. `./watch.sh`
update readme 2017-02-20 14:50:06 -06:00
fix typo 2017-06-01 18:21:07 -04:00			This will set up a monitor that will automatically compile any changes to JS or CSS folders inside of the `ui` folder. This allows you to make changes and see them immediately by reloading the app.
initial electron app 2017-01-16 14:06:53 -05:00
update README 2017-06-01 18:20:29 -04:00			`### Packaging`
initial electron app 2017-01-16 14:06:53 -05:00
update readme 2017-02-20 14:50:06 -06:00			`We use [electron-builder](https://github.com/electron-userland/electron-builder)`
			`to create distributable packages, which is run by calling:`
initial electron app 2017-01-16 14:06:53 -05:00
update readme 2017-02-20 14:50:06 -06:00			`node_modules/.bin/build -p never`
minor readme changes 2017-02-21 13:10:20 -05:00
			`### Development on Windows`

			`This project has currently only been worked on in Linux and macOS. If you are on Windows, you can`
Fix .appveyor.yml link in README.md Someone seems to have forgotten a dot in the URL. 2017-04-22 15:21:04 +01:00			`checkout out the build steps in [appveyor.yml](https://github.com/lbryio/lbry-app/blob/master/.appveyor.yml) and probably figure out something from there.`
add i18n to README 2017-05-31 12:59:58 +02:00
			`## Internationalization`

update setup -add node /nvm link -add keytar/libsecret -add yarn Feel free to adjust directions/wording 2017-08-17 13:04:04 -04:00			If you want to help translating the lbry-app, you can copy the en.json file in /app/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.