Flipper
Flipper(以前称为 Sonar)是一个在iOS和Android上调试移动应用的平台,同时能在浏览器或Node.js中调试JS应用。您可以配合简洁的桌面界面来可视化、检查和控制您的应用。使用Flipper或使用插件API扩展它。
目录
移动开发
Flipper旨在成为您在iOS和Android上移动应用开发的最佳伴侣。因此,我们提供了一系列有用的工具,包括日志查看器、交互式布局检查器和网络检查器。
扩展 Flipper
Flipper 作为一个平台构建。除了使用内置的工具之外,您还可以创建自己的插件来可视化和调试您的移动应用中的数据。Flipper 会处理数据的发送和接收、调用函数以及侦听移动应用上的事件。
为 Flipper 贡献
Flipper 的桌面应用程序、原生移动 SDK 和 JS SDK 都是开源的,并采用 MIT 许可。这使得您能够查看和理解我们是如何构建插件的,当然,加入社区并帮助改进 Flipper 也是可以的。我们期待看到您在这个平台上创建什么。
在本仓库中
此仓库包含 Flipper 的所有部分,包括
- 使用 Electron 构建的 Flipper 桌面应用程序(
/desktop
) - 原生 Flipper SDK for iOS (
/iOS
) - 原生 Flipper SDK for Android(
/android
) - React Native Flipper SDK(
/react-native
) - JS Flipper SDK(
/js
) - 插件
- 日志(
/desktop/plugins/public/logs
) - 布局检查器(
/desktop/plugins/public/layout
) - 网络检查器(
/desktop/plugins/public/network
) - 共享首选项/NSUserDefaults 检查器(
/desktop/plugins/public/shared_preferences
)
- 日志(
- 网站和文档(
/website
//docs
)
入门指南
请参阅我们的入门指南以设置Flipper。或者,(仍处于实验阶段)运行npx flipper-server
以获取Flipper的基于浏览器的版本。
要求
- node >= 8
- yarn >= 1.5
- 用于开发iOS插件的需要iOS开发者工具
- Android SDK和adb
从源码构建
桌面
从源码运行
git clone https://github.com/facebook/flipper.git
cd flipper/desktop
yarn
yarn start
注意:如果您使用Windows操作系统,直到这个问题得到解决,您需要使用Yarn 1.5.1。
构建独立应用程序
在yarn build中提供--mac
、--win
、--linux
或者它们的任意组合,为指定的平台构建发布压缩文件。例如:
yarn build --mac --version $buildNumber
您可以在dist/
文件夹中找到生成的工件。
iOS SDK + 示例应用
cd iOS/Sample
rm -f Podfile.lock
pod install --repo-update
open Sample.xcworkspace
<Run app from xcode>
可以省略--repo-update
以加快安装速度,但请注意,您可能正在为过时的依赖项构建。
Android SDK + 示例应用
启动安卓模拟器,并在项目根目录下运行以下命令
./gradlew :sample:installDebug
React Native SDK + 示例应用
需要RN 0.69以上版本!
cd react-native/ReactNativeFlipperExample
yarn
yarn android
请注意,前两步只需执行一次。
或者,可以通过运行yarn ios
在iOS上启动应用。
如果是第一次运行,您还需要从react-native/ReactNativeFlipperExample/ios
文件夹运行pod install --repo-update
。
React Native Windows (Experimental)
React Native Windows 的 Flipper(实验版本)现已可用。以下步骤用于准备 React Native Flipper 项目。
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
简而言之,使用 vcpkg 安装 OpenSSL。使用 Nuget 安装 Boost。
然后,可以按照以下步骤构建和运行示例应用程序:
cd ../../ReactNativeFlipperExample
yarn install
yarn relative-deps
npx react-native run-windows
目前 React Native Flipper 没有可用的安装包。这意味着要将 Flipper 集成到任何其他现有应用程序中,需要显式添加对项目的一个引用,就像对示例应用的引用一样。
JS SDK + Sample React app
cd js/react-flipper-example
yarn
yarn start
故障排除
较旧版本的 yarm 可能会因为显示消息“等待其他 yarn 实例结束”而出错或冻结。如果发生这种情况,请先在目录 react-native/react-native-flipper
中单独运行 yarn
命令。
文档
您可以在 fbflipper.com 找到本项目的完整文档。
我们的文档是用 Docusaurus 构建的。您可以通过执行以下操作在本地构建它:
cd website
yarn
yarn start
贡献
查看CONTRIBUTING文件了解如何参与。
许可协议
Flipper遵循MIT许可协议,详细信息见LICENSE文件。