Flipper

Flipper (formerly Sonar) is a platform for debugging mobile apps on iOS and Android and, recently, even JS apps in your browser or in Node.js. Visualize, inspect, and control your apps from a simple desktop interface. Use Flipper as is or extend it using the plugin API.

In this repo
Getting started
- Requirements
Building from Source
Documentation
- Contributing
- License

Mobile development

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

Extending Flipper

Flipper 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 mobileapps. Flipper takes care of sending data back and forth, calling functions, andlistening for events on the mobile app.

Contributing to Flipper

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

In this repo

This repository includes all parts of Flipper. This includes:

Flipper's desktop app built using Electron(/desktop)
native Flipper SDKs for iOS (/iOS)
native Flipper SDKs for Android (/android)
React Native Flipper SDK (/react-native)
JS Flipper SDK (/js)
Plugins:
- Logs (/desktop/plugins/public/logs)
- Layout inspector (/desktop/plugins/public/layout)
- Network inspector (/desktop/plugins/public/network)
- Shared Preferences/NSUserDefaults inspector(/desktop/plugins/public/shared_preferences)
website and documentation (/website / /docs)

Getting started

Please refer to ourGetting Started guide to setup Flipper.Or, (still experimental) run npx flipper-server for a browser based version of Flipper.

Requirements

node >= 8
yarn >= 1.5
iOS developer tools (for developing iOS plugins)
Android SDK and adb

Building from Source

Desktop

Running from source

git clone https://github.com/facebook/flipper.gitcd flipper/desktopyarnyarn start

NOTE: If you're on Windows, you need to use Yarn 1.5.1 untilthis issue is resolved.

Building standalone application

Provide either --mac, --win, --linux or any combination of them toyarn build to build a release zip file for the given platform(s). E.g.

yarn build --mac --version $buildNumber

You can find the resulting artifact in the dist/ folder.

iOS SDK + Sample App

cd iOS/Samplerm -f Podfile.lockpod install --repo-updateopen Sample.xcworkspace<Run app from xcode>

You can omit --repo-update to speed up the installation, but watch out as youmay be building against outdated dependencies.

Android SDK + Sample app

Start up an android emulator and run the following in the project root:

./gradlew :sample:installDebug

React Native SDK + Sample app

cd react-native/ReactNativeFlipperExampleyarnyarn android

Note that the first 2 steps need to be done only once.

Alternatively, the app can be started on iOS by running yarn ios.

If this is the first time running, you will also need to runpod install --repo-update from thereact-native/ReactNativeFlipperExample/ios folder.

JS SDK + Sample React app

cd js/react-flipper-exampleyarnyarn start

Troubleshooting

Older yarn versions might show an error / hang with the message 'Waiting for theother yarn instance to finish'. If that happens, run the command yarn firstseparately in the directory react-native/react-native-flipper.