{"id":17690996,"url":"https://github.com/lijy91-archives-repos/flutter_flipperkit","last_synced_at":"2025-03-12T19:32:32.547Z","repository":{"id":41520640,"uuid":"171691962","full_name":"lijy91-archives-repos/flutter_flipperkit","owner":"lijy91-archives-repos","description":"Flipper (Extensible mobile app debugger) for flutter.","archived":true,"fork":false,"pushed_at":"2023-07-18T05:00:06.000Z","size":2036,"stargazers_count":362,"open_issues_count":5,"forks_count":58,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-11-08T07:32:34.032Z","etag":null,"topics":["debugger","devtools","flipper","flutter","flutter-debugger","flutter-devtools","network-debugger"],"latest_commit_sha":null,"homepage":"https://pub.dev/packages/flutter_flipperkit","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lijy91-archives-repos.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"custom":"https://www.paypal.me/lijy91"}},"created_at":"2019-02-20T14:51:14.000Z","updated_at":"2024-10-17T23:44:25.000Z","dependencies_parsed_at":"2024-01-14T19:12:14.394Z","dependency_job_id":"56ad8520-0160-4671-8581-2449a158356c","html_url":"https://github.com/lijy91-archives-repos/flutter_flipperkit","commit_stats":null,"previous_names":["lijy91-archives-repos/flutter_flipperkit","leanflutter/flutter_flipperkit"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lijy91-archives-repos%2Fflutter_flipperkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lijy91-archives-repos%2Fflutter_flipperkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lijy91-archives-repos%2Fflutter_flipperkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lijy91-archives-repos%2Fflutter_flipperkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lijy91-archives-repos","download_url":"https://codeload.github.com/lijy91-archives-repos/flutter_flipperkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243281248,"owners_count":20266175,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["debugger","devtools","flipper","flutter","flutter-debugger","flutter-devtools","network-debugger"],"created_at":"2024-10-24T12:01:41.451Z","updated_at":"2025-03-12T19:32:32.541Z","avatar_url":"https://github.com/lijy91-archives-repos.png","language":"Java","funding_links":["https://www.paypal.me/lijy91"],"categories":["Java"],"sub_categories":[],"readme":"# flutter_flipperkit\n\n[![pub version][pub-image]][pub-url]\n\n[pub-image]: https://img.shields.io/pub/v/flutter_flipperkit.svg\n[pub-url]: https://pub.dev/packages/flutter_flipperkit\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*\n\n- [flutter_flipperkit](#flutter_flipperkit)\n  - [Introduction](#introduction)\n    - [Features](#features)\n  - [Quick Start](#quick-start)\n    - [Prerequisites](#prerequisites)\n    - [Installation](#installation)\n      - [Android](#android)\n      - [iOS](#ios)\n    - [Usage](#usage)\n    - [Run the app](#run-the-app)\n  - [Related Links](#related-links)\n  - [Discussion](#discussion)\n  - [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Introduction\n\n[Flipper](https://fbflipper.com) (Extensible mobile app debugger) for flutter. [View document](https://flutter-widget.live/flutter_flipperkit)\n\n![](./screenshots/flipper.png)\n\n### Features\n\n- Network inspector\n- Shared preferences inspector\n- Redux inspector\n- Database Browser\n\n## Quick Start\n\n### Prerequisites\n\nBefore starting make sure you have:\n\n- Installed [Flipper Desktop](https://fbflipper.com/)\n\n### Installation\n\nAdd this to your package's pubspec.yaml file:\n\n```yaml\ndependencies:\n  flutter_flipperkit: ^0.0.29\n```\n\nOr\n\n```yaml\ndependencies:\n  flutter_flipperkit:\n    git:\n      url: https://github.com/leanflutter/flutter_flipperkit\n      ref: main\n```\n\n#### Android\n\nChange your project files according to the example:\n\n`android/settings.gradle`:\n\n```diff\ninclude ':app'\n\ndef localPropertiesFile = new File(rootProject.projectDir, \"local.properties\")\ndef properties = new Properties()\n\nassert localPropertiesFile.exists()\nlocalPropertiesFile.withReader(\"UTF-8\") { reader -\u003e properties.load(reader) }\n\ndef flutterSdkPath = properties.getProperty(\"flutter.sdk\")\nassert flutterSdkPath != null, \"flutter.sdk not set in local.properties\"\napply from: \"$flutterSdkPath/packages/flutter_tools/gradle/app_plugin_loader.gradle\"\n\n+ def flutterProjectRoot = rootProject.projectDir.parentFile.toPath()\n+ def plugins = new Properties()\n+ def pluginsFile = new File(flutterProjectRoot.toFile(), '.flutter-plugins')\n+ assert pluginsFile.exists()\n+ pluginsFile.withReader(\"UTF-8\") { reader -\u003e plugins.load(reader) }\n+ plugins.each { name, path -\u003e\n+     def pluginDirectory = flutterProjectRoot.resolve(path).resolve('android').toFile()\n+     if (name == 'flutter_flipperkit') {\n+         include ':flipper-no-op'\n+         project(':flipper-no-op').projectDir = new File(pluginDirectory, 'flipper-no-op')\n+     }\n+ }\n\n```\n\n#### iOS\n\n\u003e Open `ios/Runner.xcworkspace` Add a empty Swift file (e.g `Runner-Noop.swift`) into `Runner` Group And make sure the `Runner-Bridging-Header.h` file is created. \n\nChange your project `ios/Podfile` file according to the example:\n\n```diff\n# Uncomment this line to define a global platform for your project\n# platform :ios, '11.0'\n\n# CocoaPods analytics sends network stats synchronously affecting flutter build latency.\nENV['COCOAPODS_DISABLE_STATS'] = 'true'\n\nproject 'Runner', {\n  'Debug' =\u003e :debug,\n  'Profile' =\u003e :release,\n  'Release' =\u003e :release,\n}\n\ndef flutter_root\n  generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__)\n  unless File.exist?(generated_xcode_build_settings_path)\n    raise \"#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first\"\n  end\n\n  File.foreach(generated_xcode_build_settings_path) do |line|\n    matches = line.match(/FLUTTER_ROOT\\=(.*)/)\n    return matches[1].strip if matches\n  end\n  raise \"FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get\"\nend\n\nrequire File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root)\n\nflutter_ios_podfile_setup\n\ntarget 'Runner' do\n  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))\nend\n\npost_install do |installer|\n  installer.pods_project.targets.each do |target|\n    flutter_additional_ios_build_settings(target)\n  end\nend\n\n```\n\n### Usage\n\n```dart\nimport 'package:flutter_flipperkit/flutter_flipperkit.dart';\n\nvoid main() {\n  FlipperClient flipperClient = FlipperClient.getDefault();\n\n  flipperClient.addPlugin(new FlipperNetworkPlugin(\n    // If you use http library, you must set it to false and use https://pub.dev/packages/flipperkit_http_interceptor\n    // useHttpOverrides: false,\n    // Optional, for filtering request\n    filter: (HttpClientRequest request) {\n      String url = '${request.uri}';\n      if (url.startsWith('https://via.placeholder.com') || url.startsWith('https://gravatar.com')) {\n        return false;\n      }\n      return true;\n    }\n  ));\n  flipperClient.addPlugin(new FlipperReduxInspectorPlugin());\n  flipperClient.addPlugin(new FlipperSharedPreferencesPlugin());\n  flipperClient.start();\n\n  runApp(MyApp());\n}\n\n...\n\n```\n\n\u003e Please refer to [examples](https://github.com/leanflutter/flutter_flipperkit_examples), to integrate `flutter_flipperkit` into your project.\n\nYou can install packages from the command line:\n\n```bash\n$ flutter clean\n$ flutter packages get\n```\n\n### Run the app\n\n```bash\n$ flutter run\n```\n\n## Related Links\n\n- https://github.com/facebook/flipper\n- https://github.com/leanflutter/flipper-plugin-dbbrowser\n- https://github.com/leanflutter/flipper-plugin-reduxinspector\n\n## Discussion\n\nIf you have any suggestions or questions about this project, you can discuss it by [Telegram Group](https://t.me/joinchat/I4jz1FE5sBGk7V0jUpzSXg) with me.\n\n## License\n\n```text\nMIT License\n\nCopyright (c) 2019-2023 LiJianying \u003clijy91@foxmail.com\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flijy91-archives-repos%2Fflutter_flipperkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flijy91-archives-repos%2Fflutter_flipperkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flijy91-archives-repos%2Fflutter_flipperkit/lists"}