flipper/docs/getting-started.md

id, title, sidebar_label

id	title	sidebar_label
getting-started	Getting Started	Getting Started

Sonar helps you debug Android and iOS apps running in an emulator/simulator or connected physical development devices. Sonar consists of two parts:

• The desktop app for macOS
• The native mobile SDKs for Android and iOS

To use Sonar, you need to add the mobile SDK to your app.

Setup

Desktop app

The desktop part of Sonar doesn't need any particular setup. Simply download the latest build of our app and launch it. The desktop app is available for macOS and requires a working installation of the Android/iOS development tools on your system.

Once you start Sonar and launch an emulator/simulator or connect a device, you will already be able to see the device logs in Sonar. To see app specific data, you need to integrate our native SDKs with your app.

Setup your Android app

Including Sonar via jcenter

Sonar is still being deployed to jcenter so you may need to include the .aar manually.

Add dependencies to your build.gradle file.

repositories {
  jcenter()
}

dependencies {
  debugCompile 'com.facebook.sonar:sonar:0.0.1'
}

Manually including sonar.aar

Download the latest .aar from GitHub releases and put it in your app's libs/ folder.

repositories {
  jcenter()
  flatDir {
    dirs 'libs'
  }
}

dependencies {
  debugCompile(name:'sonar-0.0.1', ext:'aar')
}

Now you can initialize Sonar in your Application's onCreate-method like this:

public class MyApplication extends Application {

  @Override
  public void onCreate() {
    super.onCreate();

    if (BuildConfig.DEBUG && SonarUtils.isMainProcess(mApplicationContext)) {
      final SonarClient client = AndroidSonarClient.getInstance(this);
      client.addPlugin(new MySonarPlugin());
      client.start();
    }
  }
}

Setup your iOS app

To integrate with our iOS app, you can use CocoaPods. Add the mobile Sonar SDK to your Podfile:

platform :ios, '8.0'

target 'MyApp' do
  pod 'Sonar', '~> 0.0.1'
en

and install the dependencies by running pod install. When you open the Xcode workspace file for your app, you now can import and initialize Sonar in your AppDelegate.

#import <Sonar/SonarClient.h>

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
#if DEBUG
  SonarClient *client = [SonarClient sharedClient];
  [client addPlugin:[MySonarPlugin new]];
  [client start];
#endif
  ...
}
@end

Ready for takeoff

Finally you need to add plugins to your Sonar client. See Network Plugin and Layout Inspector Plugin on how to add them.