lborsato / sonar

A desktop debugging platform for mobile developers.

Sonar

Sonar is a platform for debugging mobile apps on iOS and Android. Visualize, inspect, and control your apps from a simple desktop interface. Use Sonar as is or extend it using the plugin API.

Mobile development

Sonar aims to be your number one companion for mobile app development on iOS and Android. Therefore, we provide a bunch of useful tools including a log viewer, interactive layout inspector, and network inspector.

Extending Sonar

Sonar is built as a platform. In addition to using the tools already included, you can create your own plugins to visualize and debug data from your mobile apps. Sonar takes care of sending data back and forth, calling functions, and listening for events on the mobile app.

Contributing to Sonar

Both Sonar's desktop app and native mobile SDKs are open-source and MIT licensed. This enables you to see and understand how we are building plugins, and of course join the community and help improve Sonar. We are excited to see what you will build on this platform.

In this repo

This repository includes all parts of Sonar. This includes:

• Sonar's desktop app built using Electron (/src)
• native Sonar SDKs for iOS (/iOS)
• native Sonar SDKs for Android (/android)
• Plugins:
  • Logs (/src/device-plugins/logs)
  • Layout inspector (/src/plugins/layout)
  • Network inspector (/src/plugins/network)
• website and documentation (/website / /docs)

Getting started

Please refer to our Getting Started guide to set up Sonar.

Requirements

• macOS (while Sonar is buildable using other systems as well, only macOS is officially supported)
• node >= 8
• yarn >= 1.5
• iOS developer tools (for developing iOS plugins)
• Android SDK and adb

Starting the desktop app

git clone https://github.com/facebook/Sonar.git
cd Sonar
yarn
yarn start

Building the desktop app

yarn build [macOnly] [build-number=$buildNumber]

A binary for macOS is created in dist/mac. macOnly and build-number are optional params.

Documentation

Find the full documentation for this project at fbsonar.com.

Contributing and license

See the CONTRIBUTING file for how to help out. Sonar is MIT licensed, as found in the LICENSE file.