{"id":13491386,"url":"https://github.com/jk-gan/redux-flipper","last_synced_at":"2025-04-04T15:08:13.605Z","repository":{"id":42881014,"uuid":"256223230","full_name":"jk-gan/redux-flipper","owner":"jk-gan","description":"Redux middleware for React Native for Flipper","archived":false,"fork":false,"pushed_at":"2024-03-05T14:15:20.000Z","size":1016,"stargazers_count":159,"open_issues_count":15,"forks_count":22,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-27T04:08:55.317Z","etag":null,"topics":["flipper","hacktoberfest","react-native","redux","redux-middleware"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jk-gan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-16T13:30:06.000Z","updated_at":"2024-10-29T06:59:41.000Z","dependencies_parsed_at":"2024-06-18T13:58:41.397Z","dependency_job_id":"a00bad8e-897b-4d61-a165-0098180e8da4","html_url":"https://github.com/jk-gan/redux-flipper","commit_stats":{"total_commits":69,"total_committers":12,"mean_commits":5.75,"dds":0.5942028985507246,"last_synced_commit":"d6a1ba653dd7800ae16386cf0cc2d15a1ca04900"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jk-gan%2Fredux-flipper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jk-gan%2Fredux-flipper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jk-gan%2Fredux-flipper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jk-gan%2Fredux-flipper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jk-gan","download_url":"https://codeload.github.com/jk-gan/redux-flipper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247198459,"owners_count":20900080,"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":["flipper","hacktoberfest","react-native","redux","redux-middleware"],"created_at":"2024-07-31T19:00:56.491Z","updated_at":"2025-04-04T15:08:13.572Z","avatar_url":"https://github.com/jk-gan.png","language":"TypeScript","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# Redux Flipper\n\n![screenshot of the plugin](https://i.imgur.com/blqn8oT.png)\n\nRedux middleware for [Flipper](https://fbflipper.com/). It can log redux actions and show inside Flipper using [flipper-plugin-redux-debugger](https://github.com/jk-gan/flipper-plugin-redux-debugger).\n\n### Support\n\n- React Native\n  - For `react-native` \u003e= 0.62, flipper support is enabled by default\n  - For `react-native` \u003c 0.62, follow [these steps](https://fbflipper.com/docs/getting-started/react-native.html#manual-setup) to setup your app\n- Redux or Redux-Toolkit\n\n## Get Started\n\n1. Install [redux-flipper](https://github.com/jk-gan/redux-flipper) middleware and `react-native-flipper` in your React Native app:\n\n```bash\nyarn add redux-flipper react-native-flipper\n# for iOS\ncd ios \u0026\u0026 pod install\n```\n\n2. Add the middleware into your redux store:\n\n```javascript\nimport { createStore, applyMiddleware } from 'redux';\n\nconst middlewares = [\n  /* other middlewares */\n];\n\nif (__DEV__) {\n  const createDebugger = require('redux-flipper').default;\n  middlewares.push(createDebugger());\n}\n\nconst store = createStore(RootReducer, applyMiddleware(...middlewares));\n```\n\nRedux Toolkit\n\n```javascript\nconst middlewares = [\n  /* other middlewares */\n];\n\nif (__DEV__) {\n  const createDebugger = require('redux-flipper').default;\n  middlewares.push(createDebugger());\n}\n\nconst store = configureStore({\n  reducer: {},\n  middleware: (getDefaultMiddleware) =\u003e getDefaultMiddleware().concat(middleware),\n});\n```\n\n3. Install [flipper-plugin-redux-debugger](https://github.com/jk-gan/flipper-plugin-redux-debugger) in Flipper desktop client:\n\n```\nManage Plugins \u003e Install Plugins \u003e search \"redux-debugger\" \u003e Install\n```\n\n4. Start your app, then you should be able to see Redux Debugger on your Flipper app\n\n## Optional Configuration\n\n### State whitelisting\n\nMany times you are only interested in certain part of the Redux state when debugging. You can pass array of string which have to match to the root key of the Redux state.\n\nFor example if Redux schema is something like this and you are only interested in user then you can whitelist only that part of the state\n\n```typescript\ntype ReduxState = {\n  todos: string[];\n  notifications: string[];\n  user: {\n    name: string;\n  };\n};\n```\n\n```javascript\nlet reduxDebugger = createDebugger({ stateWhitelist: ['user'] });\n```\n\nIf you app has very big state tree it is also good idea to whitelist certain keys from Redux state otherwise Flipper can be very slow.\n\n### Resolve cyclic reference\n\nRedux Debugger does not support cyclic reference objects by default as resolving it makes application slow. This feature can be enabled by passing `{ resolveCyclic: true }` into `createDebugger`.\n\nThis is just a temporary solution if debugging is urgent. It is advisable to restructure your redux state structure.\n\nFor more information about cyclic reference, visit [MDN Cyclic Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value).\n\n```javascript\nlet reduxDebugger = createDebugger({ resolveCyclic: true });\n```\n\n### Actions Blacklist\n\nYou may specify an actions blacklist the same way as with React Native Debugger, by providing an\narray of strings to match against the action.type field.\nThis feature can be enabled by passing `{ actionsBlacklist }` into `createDebugger`,\nwhere `actionsBlacklist` is an array of strings.\n\nFor example:\n\n```javascript\nconst actionsBlacklist = ['EVENTS/', 'LOCAL/setClock'];\nconst reduxDebugger = createDebugger({ actionsBlacklist });\n```\n\nThis will exclude any actions that contain the substrings in the blacklist. So an action with type\n`EVENTS/foo` will not be sent to the redux debugger flipper plugin, but an action with type\n`LOCAL/anotherAction` will.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjk-gan%2Fredux-flipper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjk-gan%2Fredux-flipper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjk-gan%2Fredux-flipper/lists"}