Have you run through the Quick Start guide?
Run through steps 1-4 on the Quick Start guide before beginning this guide.
Install Xcode 10 through the Appstore here.
To develop using XCode, you will need a paid Apple Developer account.
If you do not have an account, use the Viro Media Testbed App by following the instructions at Using the Testbed App.
Ensure you have at least Ruby 2.2 installed, you can check this by running
If you have an older version, follow the instructions here based on your OS/package manager/ruby manager:
We use CocoaPods to manage our dependencies on iOS.
Run the following in your terminal and input computer password if needed:
gem install cocoapods
If you already have CocoaPods installed, you should still run
pod repo update in order to ensure your manifest is updated with the latest package versions.
This could take a while as the command performs a git pull of the entire CocoaPods manifest repository.
In the terminal, navigate to the root of your project (not your iOS project, but ViroReact project) and run the following command:
Which will set up the project to work with Viro.
If your app doesn't support `use_frameworks!` in Cocoapods...
Read this page Integrating w/o use_frameworks! (Cocoapods)
First, we need to open Xcode. To do so, open a new terminal window and navigate to the
ios directory in your project and run:
Your workspace should now be open in Xcode.
To add your Apple Account to Xcode follow the instructions here:
Once you add your Apple ID to Xcode, select your Project in the left navigation panel, select your App target and under the Signing section, select your Team.
Do the same for the
<ProjectName>Tests target too.
Connect your device to your development machine. Tap "Trust" if prompt appears on your computer and/or device.
Then, select your connected device in the top Active Scheme dropdown menu:
Run the application and you should see the Hello World scene.
Congratulations, you now have ViroReact set up and running!
Interesting in trying out ARKit 1.5 Features?
Read this guide: Enable ARKit 1.5 (Beta) Features
Here's a list of known issues that may appear during the installation process. Post here if you have an issue not listed here.
Missing node_modules Directory/Error with
npm install command
This is probably because you do not have
node.js installed and so, the init script failed to run
npm install. To fix this, go to your root directory and run the below commands:
npm install cd ios pod repo update pod install
Once you run those commands, your project should be properly set-up. Now you can start developing!
Unable to connect to the package server...
Here are a few things you can try to resolve this issue:
- The packager may not be running, to run it, you need to run
npm startfrom your project's root
- Try disconnecting and connecting to the network (on both device and dev machine)
- Try performing a clean build and re-install of the app
- You may need to disconnect your laptop from ethernet
Problems with installation? Need extra help? Post your issue here.