A desktop debugging platform for mobile developers.
fbflipper.com
Important Accouncement
Flipper is moving away from its Electron distribution to an in-Browser experience.
How does this affect me?
Functionality hasn't changed. The UI remains unchanged.
Flipper will run in your default browser instead of a standalone
application.
If you build from source, Flipper will open in the browser instead of a
standalone app. We also provide a MacOS app for the Flipper runtime
which can be run and will also open Flipper in the browser.
The last Electron release is v0.239.0. As such, future releases will not include Electron artifacts.
React Native support
If you are debugging React Native applications, v0.239.0
will be the last release with support for it due to technical
limitations for React Dev Tools and Hermes Debugger plugins. As such,
please refer to that release when debugging React Native applications.
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.
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, 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
(/desktop)
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.
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.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
Provide either --mac, --win, --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 dist/ folder.
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
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 yarn ios.
If this is the first time running, you will also need to run
pod install --repo-update from the
react-native/ReactNativeFlipperExample/ios folder.
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
In a nutshell, vcpkg is used to install
OpenSSL. Nuget is used to install
Boost.
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
Troubleshooting
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 yarn first
separately in the directory react-native/react-native-flipper.
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:
It's actually really amazing how many people now use Cloud Save. In fact, when I
first built this, I had no idea how anyone would possibly find this extension of
any practical use whatsoever. I still only have a vague idea as to how it could
be used, so this probably implies that I'm not the best maintainer of this project
but at least it's popular and rather awesome. Personally, I find drag2up much more
original, innovative and awesome.
Cloud Save is still pretty cool though. And it's not a terrible name, actually. Its
probably the one project of mine which actually has a fairly decent name.
Right now, I'm going to try doing development of cloud save on the cloud via the
cloud9 IDE on a Cr-48. It's going pretty well so far and it's really awesome.
Design for Cloud Save 1.2
Version 1.2 will feature tons and tons of magic. Really really magical magic.
The basis is a moving window-ish persistant stack which contains the names of hosts
used. eg. dropbox, dropbox, picasa, picasa, box.net, google docs, dropbox, google docs, dropbox
Right now, I figure the ideal value is 10. Why? Because Math.sqrt(10) day is next
week and also incidentally my birthday is on sqrt(10) day. It's also between five
and fifteen, if my third grade arithmetic skills are still intact.
So this moving window is kept persistantly via localStorage. It gets processed and
sorted into unique elements: dropbox, picasa, google docs, box.net. Then those are
sorted by a magical ranking coefficient.
The general formula for this ranking index is
number_of_times_used_in_past_10 + most_recent_index / index_dampening_factor
dropbox was used 4 times in that list - most recent is the last one of the list of so index 8
picasa twice - most recent index is 3
box.net once - most recent index is 4
google docs twice - most recent index is 7
the index dampening factor should be a big number. the second term in the magical
equation that is used here exists for the sole purpose of breaking ties between
things used an equal number of times to favor those who have been used more recently
(or should it be a smaller number?). A good value is something like the total
size of the moving window multiplied by 10. But to be safe, something like 1000 could
be used. Though any number should theoretically work, for debugging purposes it would
be nice if it was a power of ten.
The top six most recently used hosts will be shown. Or less than that if the last
ten include less than six items (again, ordered by the rank thing).
Once a file is uploaded, the list must be recalculated and generated.
The first level menu will be the same:
Cloud Save >
Second level:
Save As... >
------------
HOst1
Host2
Host3
Host5
Host6
Host4
------------
More >
There are two tertiary menus. Save As... however looks exactly like the secondary
level menu but without another save as submenu (obviously).
So the More.. menu, which is the only interesting tertiary menu will be as follows:
Add/Remove...
-------------
HostA
HostB
HostC
HostD
HostE
HostF
HostG
HostH
...
As follows. The tertiary list will include all the other hosts in alphabetical order.
Add/Remove is sort of a misnomer as it will not actually do anything in verison 1.2
instead, it'll be a link to the settings page which will do virtually nothing except
for configuring some very magical variable coefficients and stuff. probably.
These plans were written at 4:23PM Eastern Standard Time on the Eleventh of March of
the year 2011.
