{"id":13422604,"url":"https://github.com/zalmoxisus/remote-redux-devtools","last_synced_at":"2025-05-14T11:12:13.461Z","repository":{"id":44660514,"uuid":"48318543","full_name":"zalmoxisus/remote-redux-devtools","owner":"zalmoxisus","description":"Redux DevTools remotely.","archived":false,"fork":false,"pushed_at":"2023-04-25T11:18:31.000Z","size":211307,"stargazers_count":1806,"open_issues_count":63,"forks_count":139,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-04-27T16:41:14.445Z","etag":null,"topics":["debug","devtools","redux","remotedev"],"latest_commit_sha":null,"homepage":"http://zalmoxisus.github.io/monitoring/","language":"JavaScript","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/zalmoxisus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2015-12-20T12:01:15.000Z","updated_at":"2025-04-12T10:00:37.000Z","dependencies_parsed_at":"2024-04-09T19:58:18.147Z","dependency_job_id":"92d6763e-fda9-49c3-9c5f-0c8666662ffc","html_url":"https://github.com/zalmoxisus/remote-redux-devtools","commit_stats":{"total_commits":242,"total_committers":21,"mean_commits":"11.523809523809524","dds":0.1776859504132231,"last_synced_commit":"e79cf7a251d95dfde0499f9864d05cb20a518c48"},"previous_names":["zalmoxisus/redux-remote-monitor"],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalmoxisus%2Fremote-redux-devtools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalmoxisus%2Fremote-redux-devtools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalmoxisus%2Fremote-redux-devtools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zalmoxisus%2Fremote-redux-devtools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zalmoxisus","download_url":"https://codeload.github.com/zalmoxisus/remote-redux-devtools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252618454,"owners_count":21777236,"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":["debug","devtools","redux","remotedev"],"created_at":"2024-07-30T23:00:48.693Z","updated_at":"2025-05-14T11:12:08.438Z","avatar_url":"https://github.com/zalmoxisus.png","language":"JavaScript","funding_links":[],"categories":["Dev Tools","Uncategorized","Dev tools / Inspection tools","JavaScript","Marks"],"sub_categories":["Redux","Uncategorized","Side Effects","[React - A JavaScript library for building user interfaces](http://facebook.github.io/react)"],"readme":"Remote Redux DevTools\n=====================\n\n\u003eThis package was renamed to [`@redux-devtools/remote`](https://github.com/reduxjs/redux-devtools/tree/main/packages/redux-devtools-remote) and merged into [`redux-devtools` monorepo](https://github.com/reduxjs/redux-devtools). Please refer to that repository for the latest updates, issues and pull requests.\n\n![Demo](demo.gif)\n\nUse [Redux DevTools](https://github.com/gaearon/redux-devtools) remotely for React Native, hybrid, desktop and server side Redux apps.\n\n### Installation\n\n```\nnpm install --save-dev remote-redux-devtools\n```\n\n\u003e Note: for Windows use `remote-redux-devtools@0.5.0` (newer versions will not work due to a Windows issue fixed in `react-native`).\n\n### Usage\n\nThere are 2 ways of usage depending if you're using other store enhancers (middlewares) or not.\n\n#### Add DevTools enhancer to your store\n\nIf you have a basic [store](http://redux.js.org/docs/api/createStore.html) as described in the official [redux-docs](http://redux.js.org/index.html), simply replace:\n  ```javascript\n  import { createStore } from 'redux';\n  const store = createStore(reducer);\n  ```\n  with\n  ```javascript\n  import { createStore } from 'redux';\n  import devToolsEnhancer from 'remote-redux-devtools';\n  const store = createStore(reducer, devToolsEnhancer());\n  // or const store = createStore(reducer, preloadedState, devToolsEnhancer());\n  ```\n  \n\u003e Note: passing enhancer as last argument requires redux@\u003e=3.1.0\n\n#### When to use DevTools compose helper\n\n  If you setup your store with [middlewares and enhancers](http://redux.js.org/docs/api/applyMiddleware.html) like [redux-saga](https://github.com/redux-saga/redux-saga) and similar, it is crucial to use `composeWithDevTools` export. Otherwise, actions dispatched from Redux DevTools will not flow to your middlewares.\n\n  In that case change this:\n  ```javascript\n  import { createStore, applyMiddleware, compose } from 'redux';\n  \n  const store = createStore(reducer, preloadedState, compose(\n    applyMiddleware(...middleware),\n    // other store enhancers if any\n  ));\n  ```\n  to:\n  ```javascript\n  import { createStore, applyMiddleware } from 'redux';\n  import { composeWithDevTools } from 'remote-redux-devtools';\n  \n  const store = createStore(reducer, /* preloadedState, */ composeWithDevTools(\n    applyMiddleware(...middleware),\n    // other store enhancers if any\n  ));\n  ```\n  or with devTools' options:\n  ```javascript\n  import { createStore, applyMiddleware } from 'redux';\n  import { composeWithDevTools } from 'remote-redux-devtools';\n  \n  const composeEnhancers = composeWithDevTools({ realtime: true, port: 8000 });\n  const store = createStore(reducer, /* preloadedState, */ composeEnhancers(\n    applyMiddleware(...middleware),\n    // other store enhancers if any\n  ));\n  ```\n\n### Enabling\n\nIn order not to allow it in production by default, the enhancer will have effect only when `process.env.NODE_ENV === 'development'`.\n\nFor Webpack you should add it as following (`webpack.config.dev.js`):\n```js\n// ...\nplugins: [\n  new webpack.DefinePlugin({\n    'process.env.NODE_ENV': JSON.stringify('development')\n  })\n],\n// ...\n```\n\nIn case you don't set `NODE_ENV`, you can set `realtime` parameter to `true` or to other global variable to turn it off in production:\n\n```js\nconst store = createStore(reducer, devToolsEnhancer({ realtime: true }));\n```\n\n### Monitoring\n\nUse one of our monitor apps to inspect and dispatch actions:\n* [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension) - Click \"Remote\" button (or press [`Cmd+Ctrl+Arrow up`](https://github.com/zalmoxisus/redux-devtools-extension#keyboard-shortcuts)) to open remote monitoring.\n* [remotedev-rn-debugger](https://github.com/jhen0409/remotedev-rn-debugger) - Used in React Native debugger as a dock monitor.\n* [atom-redux-devtools](https://github.com/zalmoxisus/atom-redux-devtools) - Used in Atom editor.\n* [redux-dispatch-cli](https://github.com/jhen0409/redux-dispatch-cli) - A CLI tool for Redux remote dispatch.\n* [vscode-redux-devtools](https://github.com/jkzing/vscode-redux-devtools) - Used in Visual Studio Code.\n\nUse [remotedev-app](https://github.com/zalmoxisus/remotedev-app) to create your own monitor app.\n\n### Communicate via local server\n\nUse [remotedev-server](https://github.com/zalmoxisus/remotedev-server) cli to run it locally in order to make the connection faster and not to require an internet connection.\nYou can import it in your `server.js` script and start remotedev server together with your development server:\n```js\nvar remotedev = require('remotedev-server');\nremotedev({ hostname: 'localhost', port: 8000 });\n```\nSee [remotedev-server](https://github.com/zalmoxisus/remotedev-server) repository for more details.\nFor React Native you can use [remotedev-rn-debugger](https://github.com/jhen0409/remotedev-rn-debugger), which already include `remotedev-server`.\n\n\n### Parameters\n\nName                    | Description\n-------------           | -------------\n`name`                  | *String* representing the instance name to be shown on the remote monitor.\n`realtime`              | *Boolean* specifies whether to allow remote monitoring. By default is `process.env.NODE_ENV === 'development'`. \n`hostname`              | *String* used to specify host for [`remotedev-server`](https://github.com/zalmoxisus/remotedev-server). If `port` is specified, default value is `localhost`.\n`port`                  | *Number* used to specify host's port for [`remotedev-server`](https://github.com/zalmoxisus/remotedev-server).\n`secure`                | *Boolean* specifies whether to use `https` protocol for [`remotedev-server`](https://github.com/zalmoxisus/remotedev-server).\n`maxAge`                | *Number* of maximum allowed actions to be stored on the history tree, the oldest actions are removed once maxAge is reached. Default is `30`.\n`actionsBlacklist`      | *array* of actions to be hidden in DevTools. Overwrites corresponding global setting in the options page. See the example bellow.\n`actionsWhitelist`      | *array* of actions to be shown. All other actions will be hidden in DevTools.\n`actionSanitizer`       | *Function* which takes action object and id number as arguments, and should return action object back. See the example bellow.\n`stateSanitizer`        | *Function* which takes state object and index as arguments, and should return state object back. See the example bellow.\n`startOn`               | *String* or *Array of strings* indicating an action or a list of actions, which should start remote monitoring (when `realtime` is `false`). \n`stopOn`                | *String* or *Array of strings* indicating an action or a list of actions, which should stop remote monitoring. \n`sendOn`                | *String* or *Array of strings* indicating an action or a list of actions, which should trigger sending the history to the monitor (without starting it). *Note*: when using it, add a `fetch` polyfill if needed.\n`sendOnError`           | *Numeric* code: `0` - disabled (default), `1` - send all uncaught exception messages, `2` - send only reducers error messages.\n`sendTo`                | *String* url of the monitor to send the history when `sendOn` is triggered. By default is `${secure ? 'https' : 'http'}://${hostname}:${port}`.\n`actionCreators`        | *Array* or *Object* of action creators to dispatch remotely. See [the example](https://github.com/zalmoxisus/remote-redux-devtools/commit/b54652930dfd4e057991df8471c343957fd7bff7).\n`shouldHotReload`       | *Boolean* - if set to `false`, will not recompute the states on hot reloading (or on replacing the reducers). Default to `true`.\n `shouldRecordChanges`  | *Boolean* - if specified as `false`, it will not record the changes till clicked on \"Start recording\" button on the monitor app. Default is `true`.\n `shouldStartLocked`    | *Boolean* - if specified as `true`, it will not allow any non-monitor actions to be dispatched till `lockChanges(false)` is dispatched. Default is `false`.\n`id`                    | *String* to identify the instance when sending the history triggered by `sendOn`. You can use, for example, user id here, to know who sent the data.\n`suppressConnectErrors` | *Boolean* - if set to `false`, all socket errors thrown while trying to connect will be printed to the console, regardless of if they've been thrown before. This is primarily for suppressing `SocketProtocolError` errors, which get repeatedly thrown when trying to make a connection.  Default is `true`.\n\nAll parameters are optional. You have to provide at least `port` property to use `localhost`.\n\nExample:\n```js\nexport default function configureStore(preloadedState) {\n  const store = createStore(\n    reducer,\n    preloadedState,\n    devToolsEnhancer({\n      name: 'Android app', realtime: true,\n      hostname: 'localhost', port: 8000,\n      maxAge: 30, actionsBlacklist: ['EFFECT_RESOLVED'],\n      actionSanitizer: (action) =\u003e (\n       action.type === 'FILE_DOWNLOAD_SUCCESS' \u0026\u0026 action.data ?\n       { ...action, data: '\u003c\u003cLONG_BLOB\u003e\u003e' } : action\n      ),\n      stateSanitizer: (state) =\u003e state.data ? { ...state, data: '\u003c\u003cLONG_BLOB\u003e\u003e' } : state\n    })\n  );\n  return store;\n}\n```\n\n### Demo\n- [Toggle monitoring](http://zalmoxisus.github.io/monitoring/)\n\n### Examples\n- [Web](https://github.com/zalmoxisus/remote-redux-devtools/tree/master/examples)\n- [React Native](https://github.com/chentsulin/react-native-counter-ios-android)\n\n### License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzalmoxisus%2Fremote-redux-devtools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzalmoxisus%2Fremote-redux-devtools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzalmoxisus%2Fremote-redux-devtools/lists"}