Skip to content

Latest commit

 

History

History
123 lines (74 loc) · 4 KB

SETUP.md

File metadata and controls

123 lines (74 loc) · 4 KB
Raw

Setting up the Starter Kit

Requirements

Firstly, you need a Mac computer for iOS development. If you want to build an Android app only, you can try experimental Linux and Windows support. These instructions presume an OS X installation.

Before you get started, make sure you have the following dependencies installed on your machine:

  • NodeJS >=5 and npm 3. npm 2 is not supported.

  • Homebrew (or an alternative way to install OSX packages)

  • Latest React Native CLI

        $ npm install -g react-native-cli

Installation

Install dependencies from NPM

$ npm install

Create a blank configuration file

$ cp env.example.js env.js

Running the iOS application

  1. Install Requirements:
  • Xcode for iOS development (download from Mac App Store)
  • Ruby (>2.2) to run CocoaPods
  • CocoaPods 1.0 or newer for iOS package management.

Please note that CocoaPods 0.x will not work, and at the time of writing the version in Homebrew is still 0.39, so check your pod --version and install 1.0 with gem if necessary.

  1. Install native iOS dependencies

     $ (cd ios; pod repo update; pod install)

  2. Build the app and run the simulator:

     $ react-native run-ios

Running the Android application

More details here: React Native Android Setup

  1. Install latest JDK

  2. Install the Android SDK

       $ brew install android-sdk

  3. Set ANDROID_HOME environment variable in .bashrc, .zshrc or similar:

       $ export ANDROID_HOME=/usr/local/opt/android-sdk

  4. Start Android SDK Manager

       $ android

  5. Add SDK tools via Android sdk manager

  • Android SDK tools
  • Android SDK Platform-tools
  • Android SDK Build-tools (Important: Rev. 23.0.1)
  • SDK Platform
  • Intel x86 Atom_64 System Image
  • Intel x86 Atom System Image
  • Android Support Repository
  • Android Support Library
  • Intel x86 Emulator Accelerator (HAXM installer)

  1. Configure and install hardware acceleration

       $ open /usr/local/opt/android-sdk/extras/intel/Hardware_Accelerated_Execution_Manager/IntelHAXM_<version>.dmg

  2. Open Android Virtual Device manager

       $ android avd

  3. Add new virtual device

  • name: reactnative
  • Device: Nexus 5
  • Target: Android 6 - API Level 23
  • CBU: Intel Atom x86
  • check Use Host GPU

  1. Build app and run emulator:

     $ react-native run-android

Auth0

Configuration

If you don't want to use Auth0, or you want to take it into use later, you can skip this step for now.

  1. Before you start you need to create a new application in Auth0

  2. Set AUTH0_CLIENT_ID and AUTH0_DOMAIN in env.js according to your application you created in Auth

     AUTH0_CLIENT_ID: '<CLIENT_ID>',
 AUTH0_DOMAIN: '<ACCOUNT_NAME>.eu.auth0.com'

  3. Follow the steps for your platform below. Check the official instructions for more information.

Customization

The Auth0 login and sign up screens can be customized through the Lock extension.

iOS

  • Change default values in the customiseTheme method in src/services/auth0.js
  • If you want to add images, copy them in the root images folder and add them via Xcode > file > add files to the project in 3 different resolutions (needs to be original and x2 and x3 versions)
  • All changeable values can be retrieved here

Android

  • Change default values for the AppTheme.Lock in android/app/src/main/res/values/styles.xml
  • Add images in android/app/src/main/res/mipmap-<hdpi|mdpi|xhdpi|xxhdpi> in 4 different resolutions
  • All changeable values can be retrieved here

Windows UWP

Windows not yet supported.