Skip to content
A desktop debugging platform for mobile developers.
Branch: master
Clone or download
priteshrnandgaonkar and facebook-github-bot Back out "[Flipper] Use the tree node idenitifer as the component ide…
…ntifier"

Summary:
Original commit changeset: 4d83c1bee3fd

BUG:

{F159187385}

Reviewed By: passy

Differential Revision: D15415247

fbshipit-source-id: 6209a2c9c2b5da6b9405bf01e3cb7622b3431475
Latest commit 0a514c3 May 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Automate iOS release (#445) May 14, 2019
.github Add issue templates Apr 29, 2019
.vscode Initial commit 🎉 Jun 1, 2018
PortForwardingMacApp More copyright headers for misc stuff May 1, 2019
Specs Flipper Release: v0.20.0 Apr 17, 2019
android Remove gradle rhino dep May 15, 2019
docs Flipper Bump: v0.20.4-SNAPSHOT May 16, 2019
flow-typed Add "Copy cell" to ManagedTable May 8, 2019
gradle Another round of header updates May 3, 2019
headless Accept Trace file and export a metric May 17, 2019
iOS Back out "[Flipper] Use the tree node idenitifer as the component ide… May 20, 2019
libs Solve fbjni bug to allow catching Java exception in JNI Nov 19, 2018
scripts Update Mac binary May 17, 2019
src remove crash May 20, 2019
static Update copyright headers (#433) May 4, 2019
website Fix broken link on Getting Started May 7, 2019
xplat More headers May 3, 2019
.eslintignore Upgrading flow and fixing lint errors Feb 1, 2019
.eslintrc.js Declare prettier the winner Apr 5, 2019
.flowconfig Upgrading flow and fixing lint errors Feb 1, 2019
.gitignore Ignore Podfile.lock (#297) Oct 21, 2018
.sonarhandles Initial commit 🎉 Jun 1, 2018
.travis.yml Build Android app on Travis (#430) May 2, 2019
.watchmanconfig Add .watchmanconfig to fix yarn start (#265) Sep 17, 2018
.yarnrc Initial commit 🎉 Jun 1, 2018
CHANGELOG.md Create CHANGELOG.md Apr 29, 2019
CNAME Update CNAME Jul 31, 2018
CODE_OF_CONDUCT.md Initial commit 🎉 Jun 1, 2018
CONTRIBUTING.md Update README w/TOC & link Contributing & MIT sections (#222) Aug 13, 2018
DEV_ENVIRONMENT.md Create DEV_ENVIRONMENT.md (#409) Apr 5, 2019
Flipper.podspec Flipper Release: v0.20.3 May 16, 2019
FlipperKit.podspec Flipper Release: v0.20.3 May 16, 2019
LICENSE Initial commit 🎉 Jun 1, 2018
README.md Add Cocoapods README badge May 7, 2019
build.gradle Remove gradle rhino dep May 15, 2019
gradle.properties Flipper Bump: v0.20.4-SNAPSHOT May 16, 2019
gradlew Upgrade to Gradle 5.1.1 stable version (#357) Jan 23, 2019
package.json Flipper Release: v0.20.3 May 16, 2019
settings.gradle Update iOS license headers (and more) May 2, 2019
yarn.lock Upgrade prettier to 1.17.0 May 7, 2019

README.md

Flipper Build Status Android Maven Badge iOS

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

Flipper

Table of Contents

Mobile development

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.

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 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 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 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 (/src)
  • native Flipper SDKs for iOS (/iOS)
  • native Flipper SDKs for Android (/android)
  • Plugins:
    • Logs (/src/device-plugins/logs)
    • Layout inspector (/src/plugins/layout)
    • Network inspector (/src/plugins/network)
    • Shared Preferences/NSUserDefaults inspector (/src/plugins/shared_preferences)
  • website and documentation (/website / /docs)

Getting started

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

Requirements

  • macOS (while Flipper 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

Building from Source

Desktop

Running from source

git clone https://github.com/facebook/flipper.git
cd flipper
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

yarn build --mac --version $buildNumber

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:

./gradlew :sample:installDebug

Documentation

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

Contributing

See the CONTRIBUTING file for how to help out.

License

Flipper is MIT licensed, as found in the LICENSE file.

You can’t perform that action at this time.