FlipperKit 0.252.0

FlipperKit 0.252.0

×

由Lorenzo Blasa 维护。

FlipperKit 0.252.0

  • 由
  • Facebook

logo

Flipper

Android Maven Badge iOS

Flipper（之前称为 Sonar）是一个平台，用于调试 iOS 和 Android 上的移动应用程序，以及浏览器或 Node.js 中的 JS 应用程序。通过简单的桌面界面可视化、检查和控制您的应用程序。可以使用 Flipper 本身，也可以通过插件 API 进行扩展。

Flipper

目录

移动开发

Flipper 致力于成为您的首选移动应用开发伴侣，针对 iOS 和 Android。因此，我们提供了一系列有用的工具，包括日志查看器、交互式布局检查器和网络检查器。

扩展 Flipper

Flipper 被构建为一个平台。除了使用内置的工具外，您还可以创建自己的插件来可视化和调试移动应用中的数据。Flipper 负责发送数据，调用函数以及在移动应用上监听事件。

为 Flipper 做贡献

Flipper 的桌面应用程序，原生移动 SDK 和 JS SDK 均为开源，并遵循 MIT 许可证。这使得您可以查看和了解我们构建插件的方式，当然，您还可以加入社区并帮助改进 Flipper。我们期待您在这个平台上创建的内容。

在此存储库中

此存储库包含 Flipper 的所有部分，包括：

  • 使用 Electron 构建的 Flipper 桌面应用程序（/desktop）
  • 原生 iOS SDK（/iOS）
  • 原生 Android SDK（/android）
  • React Native Flipper SDK（/react-native）
  • JS Flipper SDK（/js）
  • 插件
    • 日志（/desktop/plugins/public/logs）
    • 布局检查器（/desktop/plugins/public/layout）
    • 网络检查器（/desktop/plugins/public/network）
    • Shared Preferences/NSUserDefaults 检查器（/desktop/plugins/public/shared_preferences）
  • 网站和文档（/website / /docs）

入门

请参阅我们的入门指南来设置 Flipper。或者（仍然是实验性的），运行npx flipper-server来获取 Flipper 的基于浏览器的版本。

要求

  • node >= 8
  • yarn >= 1.5
  • macOS 开发工具（用于开发 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 或它们的任意组合，为指定的平台（或平台组合）构建发布 ZIP 文件。例如：

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 + 示例应用程序

启动 Android 模拟器，然后在项目根目录中运行以下命令

./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 (实验性版本)

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 + 示例React应用

cd js/react-flipper-example
yarn
yarn start

故障排除

较旧的yarn版本可能会显示错误/挂起的消息“等待另一个yarn实例完成”。在这种情况下，请在react-native/react-native-flipper目录中单独运行命令yarn。

文档

您可以在fbflipper.com找到此项目的完整文档。

我们的文档是基于Docusaurus构建的。您可以通过运行以下命令在本地构建：

cd website
yarn
yarn start

贡献

有关如何贡献，请参阅 CONTRIBUTING 文件。

许可协议

Flipper 遵循 MIT 许可协议，如 LICENSE 文件所示。