Home

Awesome

Viro Starter Kit

This is a new React Native project, set up with @reactvision/react-viro.

How to Install Viro in an existing project?

If you are integrating ViroReact into an existing project, have a look at our Installation instructions.

Getting Started

Note: Make sure you have completed the React Native - Environment Setup instructions. Stop before you get to the Creating a new application section; we have done that for you!

Step 1: Install Dependencies

npm install

iOS only:

cd ios
pod install
cd ..

Step 2: Start the Metro Server

First, you will need to start Metro, the JavaScript bundler that ships with React Native.

To start Metro, run the following command from the root of your React Native project:

npm start

Step 3: Start your Application

Warning: Due to limitations of the Apple Simulator and the Android Emulator, you must run your project on a physical device.

Let Metro Bundler run in its own terminal. Open a new terminal from the root of your React Native project. Run the following command to start your Android or iOS app:

# iOS
npx react-native run-ios
# Android
npx react-native run-android

If everything is set up correctly, you should see your new app running on you device.

Install CocoaPods

cd ios
pod install
cd ..

# using npm
npm run ios

# OR using Yarn
yarn ios

If everything is set up correctly, you should see your new app running in your Android Emulator or iOS Simulator shortly provided you have set up your emulator/simulator correctly.

This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.

Step 4: Modifying your App

Now that you have successfully run the app, let's modify it.

  1. Open App.tsx in your text editor of choice and edit some lines.
  2. For Android: Press the <kbd>R</kbd> key twice or select "Reload" from the Developer Menu (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (on macOS)) to see your changes!

Next Steps

Check out our documentation for guides, examples, and more!

Need help?

Reach us in Discord. or submit an issue!