lbry-react-native/README.md
Akinwale Ariwodola 9582b7ad7d update readme
2020-03-02 16:08:58 +01:00

2.5 KiB

LBRY React Native

pipeline status

A mobile browser and wallet for the LBRY network. This app bundles lbrynet-daemon as a background service with a UI layer built with React Native.

LBRY Android Screenshot

Installation

The minimum supported Android version is 5.0 Lollipop. There are two ways to install:

  1. Via the Google Play Store. Anyone can join the open beta in order to install the app from the Play Store.
  2. Direct APK install available at http://build.lbry.io/android/latest.apk. You will need to enable installation from third-party sources on your device in order to install from this source.

Usage

The app can be launched by opening LBRY from the device's app drawer or via the shortcut on the home screen if that was created upon installation.

Running from Source

Software Requirements

  • Android Studio
  • WebStorm (or other IDE for editing React Native / JavaScript code)

Android Steps

  • Clone the repository using git clone https://github.com/lbryio/lbry-react-native
  • Initialise the submodules. ``` cd lbry-react-native git submodule update --init --recursive
* Open Android Studio and click File > Open...
* Navigate to the cloned repository on your local filesystem and select the `android` subfolder.
* Connect your Android device in USB debugging mode, or create an ARM emulator (slower) to run the app.
* Click Run > Run... and select the corresponding app configuration. Note that it may take a while for the project files to sync before you can run the app
* In order to edit the React Native / JavaScript files, open the cloned repository folder using WebStorm (or your favourite IDE).

## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see https://lbry.io/faq/contributing

## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).

## Security
We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is [here](https://keybase.io/lbry/key.asc) if you need it.

## Contact
The primary contact for this project is [@akinwale](https://github.com/akinwale) (akinwale@lbry.com)