Lisk Mobile

Lisk Mobile is a cross-platform application written in React Native and primarily build for iOS and Android. It provides the users with all the functionality they need to send and receive LSK tokens, as well as reviewing the activity history of their or any other account in the Lisk blockchain.

For Contributors

Please see CONTRIBUTING.md for more information.

Development

Pre-Installation

The next section details the prerequisites to install Lisk Mobile from source using the different tagged releases.

Git
- brew install git
NodeJS (recommended 8.14.0)
- brew install node
npm (recommended 5.3.0)
- npm is shipped with NodeJS. but to have a specific version installed see here.
watchman
- brew install watchman
react-native-cli
- Install using npm

iOS

You'll need the Xcode installed in your machine to run the app in simulator.

Android

Install Android Studio, which sould have these options checked installed:
- Android SDK
- Android SDK Platform
- Performance (Intel ® HAXM)
- Android Virtual Device
Install the Android SDK. Consider these configurations:
compileSdkVersion: 28
buildToolsVersion: 27.0.3

Installation

$ git clone https://github.com/LiskHQ/lisk-mobile.git
$ cd lisk-mobile
$ npm install
$ npm run start

Development environment

You can run the project in Xcode and use iOS simulators or alternatively use Android simulators. There are several options to set up your Android development environment. Please read React Native docs for more info.

Three is a standalone app for debugging React Native. it has React and Redux debugger enabled by default. Please read React Native Debugger for more info.

Environment variables

You can fill out env.json with those variables:

network             -> Lisk network's name, can be mainnet or testnet.
passphrase          -> Passphrase of your LSK account, to be filled out automatically on login.
secondPassphrase    -> Second passphrase of your LSK account, to be filled out automatically on send process.
useCommercialFonts  -> Tells styleGuide/fonts.js file to load commercial fonts instead of Open Sans.

In order to avoid commiting that file you can follow this approach as following

$ git update-index --assume-unchanged env.json

Using Commercial Fonts

Since some of the fonts used in the production version are commercial, this repository only contains open source fonts and uses Open Sans as a replacement for the commercial ones.

If you have licensed copies of Basier Circle and Gilroy, you can add them to fonts folder with the naming convention stated in styleGuide/fonts.js file and make sure all the fonts are linked.

$ react-native link ./src/assets/fonts

Run

$ npm start

Build - iOS

$ npm run build:ios

Build - Android

$ npm run build:android

Unit Tests

Single run

$ npm run test

iMessage Extension

Please check out iMessage extension docs for more information.

Contributors

See contributors section.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

cahyofendhi / lisk-mobile