e39470c3cc
TeamCity expects the dmg to be in dist/mac, but in the new electron-builder it's put directly in dist/ (in the long run the right way to solve this is to update the TeamCity config). |
||
|---|---|---|
| .github | ||
| .tx | ||
| build | ||
| flow-typed | ||
| src | ||
| static | ||
| .appveyor.yml | ||
| .bumpversion.cfg | ||
| .eslintrc.json | ||
| .flowconfig | ||
| .gitignore | ||
| .lintstagedrc | ||
| .prettierrc.json | ||
| .travis.yml | ||
| build.sh | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| Dangerfile | ||
| electron-builder.json | ||
| electron-webpack.json | ||
| flowtype-plugin.js | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| webpack.renderer.additions.js | ||
| yarn.lock | ||
LBRY App
The LBRY app is a graphical browser for the decentralized content marketplace provided by the LBRY protocol. It is essentially the lbry daemon bundled with a UI using Electron.
Installing
We provide installers for Windows, macOS, and Debian-based Linux.
| Windows | macOS | Linux | |
|---|---|---|---|
| Latest Stable Release | Download | Download | Download |
| Latest Prerelease | Download | Download | Download |
Our releases page 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
- Node.js
- Yarn
yarn --add-python-to-path install --global --production windows-build-tools(Windows only)
One-time Setup
- Clone this repo
DEPS=true ./build.sh
This will download and install the LBRY app and its dependencies, including
the LBRY daemon and command line utilities like node and yarn.
The LBRY app requires Node >= 6; if you have an earlier version of Node installed and want to keep
it, you can use nvm to switch back and forth.
Arch Linux and Other Non-Debian Distributions
Running the build script with DEPS=true triggers a bash script with apt-get specific commands.
If you are using a distribution without apt-get, try running the script as:
./build.sh
You may also have to install the package libsecret if it is not already installed.
Running
The app can be run from the sources using the following command:
yarn dev
On Windows
Windows Dependency
- Download and install
gitfrom github.io (configure to use command prompt integration) - Download and install
npmandnodefrom nodejs.org - Download and install
python 2.7from python.org - Download and Install
Microsoft Visual C++ Compiler for Python 2.7from Microsoft - Download and install
.NET Framework 2.0 Software Development Kit (SDK) (x64)from Microsoft (may need to extract setup.exe and install manually by running install.exe as Administrator)
One-time Setup
- Open a command prompt as administrator and run the following:
npm install --global --production windows-build-tools
exit
- Open a command prompt in the root of the project and run the following:
python -m pip install -r build\requirements.txt
npm install -g yarn
yarn install
yarn build
- Download the lbry daemon and CLI binaries and place
them in
static\daemon.
Build
Run yarn build.
We use electron-builder to create distributable packages.
Contributing
Please read our contributing manual 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.