lbry-desktop/README.md

29 lines
1.1 KiB
Markdown
Raw Normal View History

2016-03-15 17:10:27 +01:00
# LBRY Web User Interface
2017-01-23 22:18:04 +01:00
This is the web-based frontend for the LBRY network. It is automatically installed when a user installs [LBRY](https://github.com/lbryio/lbry).
2016-03-15 17:10:27 +01:00
## Development Setup
2016-07-20 20:24:54 +02:00
- Install [LBRY](https://github.com/lbryio/lbry/releases)
2017-01-23 22:23:07 +01:00
- Install node and npm (if you can, [use this](https://github.com/nodesource/distributions). if not, [this gist may be useful](https://gist.github.com/isaacs/579814))
2017-01-23 22:18:04 +01:00
- Checkout this project via git
- Run `./watch.sh` (this will `npm install` dependencies)
- Run LBRY
While `watch.sh` is running, any change made to the `js` or `scss` folders will automatically be compiled into the `dist` folder.
While changes will automatically compile, they will not automatically be loaded by the app. Every time a file changes, you must run:
`lbrynet-cli configure_ui path=/path/to/repo/dist`
Then reload the page. This call can also be made directly via the browser Javascript console:
`lbry.call('configure_ui', {path: '/path/to/ui'})`
To reset your UI to the version packaged with the application, run:
2016-07-21 04:06:39 +02:00
2017-01-23 22:18:04 +01:00
`lbrynet-cli configure_ui branch=master`
2016-07-21 04:06:39 +02:00
2017-01-23 22:18:04 +01:00
This command also works to test non-released branches of `lbry-web-ui`
2016-08-17 21:15:09 +02:00