__tests__ | ||
android@1a5c8b7ba7 | ||
ios | ||
src | ||
.babelrc | ||
.eslintrc.json | ||
.gitignore | ||
.gitmodules | ||
.lintstagedrc.json | ||
.prettierrc.json | ||
bundle-android.sh | ||
bundle.sh | ||
index.js | ||
lbry-app-strings.json | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
reactotron.js | ||
README.md | ||
yarn.lock |
LBRY React Native
A mobile browser and wallet for the LBRY network. This app bundles LBRY SDK as a background service with a UI layer built with React Native.
Installation
The minimum supported Android version is 5.0 Lollipop. There are two ways to install:
- Via the Google Play Store. Anyone can join the open beta in order to install the app from the Play Store.
- 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)
- npm
- yarn
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
- Install
react-native-cli
globally usingnpm install -g react-native-cli
. - Install the required package modules by running
yarn
in the cloned repository folder. - Download a
google-services.json
from the Firebase console (https://console.firebase.google.com/) and place it in theandroid/app
folder. Alternatively, use the included sample JSON file.
cp android/app/google-services.sample.json android/app/google-services.json
- 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).
React Native Fast Refresh
In order to enable fast refresh when updating React Native code
- Connect your Android device in USB debugging mode, or create an ARM emulator
- Run
adb reverse tcp:8081 tcp:8081
(adb
can be found in theplatform-tools
folder of your Android SDK installation) - Run
yarn start
- Press
r
to reload the app. - Anytime you make an update to the React Native code, the app should automatically refresh.
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.
Security
We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is here if you need it.
Contact
The primary contact for this project is @akinwale (akinwale@lbry.com)