Requirements

Depending on whether you are building Android or iOS apps, the following tools are required:

  • Node.js >= 8.3

  • NPM >= 3.0

  • Android Studio (for Android apps)

  • Xcode >= 10 (for iOS apps)

  • CocoaPods (if using a version of React Native >= 0.60)

Node

Electrode Native is primarily a Node.js application therefore, Node 8+ must be installed on your workstation.

Note You also need to install NPM or Yarn in order to install the Electrode Native platform. When you install Node.js, NPM is automatically installed.

NPM or Yarn

Git

You need to have the git command line client installed on your workstation and declared in your PATH (i.e if you type git from a command prompt / terminal, it should not fail with "command not found" error).

Electrode Native is relying on the git client for Cauldron access as well as Manifest access, and also to publish your Containers to git if you want to use such a publisher.

You need to install Android Studio if you want your MiniApp to target the Android platform or if you need to generate containers targeting Android mobile applications.

After you install Android Studio, set the ANDROID_SDK env variable to point to the location of the Android SDK--if it has not been set already. An example of the SDK path is shown below.

$ export ANDROID_SDK=/Users/[YOUR_USER_NAME]/Library/Android/sdk

Xcode

You need to install Xcode if you want your MiniApp to target the iOS platform or if you need to generate containers targeting iOS mobile applications.

Xcode 10 or later version is required.

CocoaPods

If running Electrode Native on a Mac, and using a version of React Native >= 0.60, CocoaPods install is required even if only targeting Android platform.

Additional optional requirements

  • If your workflow involves working with a cauldron, you'll need to have a GitHub or BitBucket account.

  • If your workflow involves pushing OTA updates using CodePush, you'll need to have an account setup for CodePush.

What about React Native ?

You don't need to have React Native installed on your machine. If you have it already installed, that's great--it's not really a problem. The same applies for yarn and CodePush.

Electrode Native ships with its own local version of React Native as well as Yarn and CodePush. Including these tools shorten our list of requirements--which ultimately simplifies setup for you and also makes the platform safer and stable as it does not require multiple versions of these tools--even though, every user could have a different version of these tools already installed.