Flipper (formerly Sonar) is a platform for debugging mobile apps on iOS and Android and 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.
Table of Contents
- In this repo
- Getting started
- Building from Source
Flipper 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.
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 mobile apps. Flipper takes care of sending data back and forth, calling functions, and listening for events on the mobile app.
Contributing to Flipper
Both Flipper's desktop app, native mobile SDKs, JS 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 to improve Flipper. We are excited to see 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
- native Flipper SDKs for iOS (
- native Flipper SDKs for Android (
- React Native Flipper SDK (
- JS Flipper SDK (
- Logs (
- Layout inspector (
- Network inspector (
- Shared Preferences/NSUserDefaults inspector
- Logs (
- website and documentation (
Please refer to our
Getting Started guide to set up
Flipper. Or, (still experimental) run
npx flipper-server for a browser based
version of Flipper.
- node >= 8
- yarn >= 1.5
- iOS developer tools (for developing iOS plugins)
- Android SDK and adb
Building from Source
Running from source
git clone https://github.com/facebook/flipper.git cd flipper/desktop yarn yarn start
NOTE: If you're on Windows, you need to use Yarn 1.5.1 until this issue is resolved.
Building standalone application
--linux or any combination of them to
yarn 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
iOS SDK + Sample App
cd iOS/Sample rm -f Podfile.lock pod install --repo-update open Sample.xcworkspace <Run app from xcode>
You can omit
--repo-update to speed up the installation, but watch out as you
may be building against outdated dependencies.
Android SDK + Sample app
Start up an android emulator and run the following in the project root:
React Native SDK + Sample app
Requires RN 0.69+!
cd react-native/ReactNativeFlipperExample yarn yarn android
Note that the first 2 steps need to be done only once.
Alternatively, the app can be started on
iOS by running
If this is the first time running, you will also need to run
pod install --repo-update from the
React Native Windows (Experimental)
An experimental version of Flipper for React Native Windows is available. The following steps prepare the React Native Flipper project:
cd react-native/react-native-flipper vcpkg install openssl:x64-uwp openssl:arm-uwp vcpkg integrate install yarn install cd windows nuget install ReactNativeFlipper/packages.config
Then, the sample application can be built and run as follows:
cd ../../ReactNativeFlipperExample yarn install yarn relative-deps npx react-native run-windows
At the moment there's no available package for React Native Flipper. This means that to integrate Flipper with any other existing applications, an explicit reference to the project needs to be added just as is done with the sample application.
JS SDK + Sample React app
cd js/react-flipper-example yarn yarn start
Older yarn versions might show an error / hang with the message 'Waiting for the
other yarn instance to finish'. If that happens, run the command
separately in the directory
Find the full documentation for this project at fbflipper.com.
Our documentation is built with Docusaurus. You can build it locally by running this:
cd website yarn yarn start
See the CONTRIBUTING file for how to help out.
Flipper is MIT licensed, as found in the LICENSE file.