Remote Redux DevTools

Use Redux DevTools remotely for React Native, hybrid, desktop and server side Redux apps.

Installation

npm install --save-dev remote-redux-devtools

Usage

There are 2 ways of usage depending if you're using other store enhancers (middlewares) or not.

Add DevTools enhancer to your store

If you have a basic store as described in the official redux-docs, simply replace: javascript import { createStore } from 'redux'; const store = createStore(reducer); with javascript import { createStore } from 'redux'; import devToolsEnhancer from 'remote-redux-devtools'; const store = createStore(reducer, devToolsEnhancer()); // or const store = createStore(reducer, preloadedState, devToolsEnhancer());

Note: passing enhancer as last argument requires redux@>=3.1.0

Use DevTools compose helper

If you setup your store with middleware and enhancers, change this: ```javascript import { createStore, applyMiddleware, compose } from 'redux';

const store = createStore(reducer, preloadedState, compose( applyMiddleware(...middleware), // other store enhancers if any )); to:javascript import { createStore, applyMiddleware } from 'redux'; import { composeWithDevTools } from 'remote-redux-devtools';

const store = composeWithDevTools(reducer, / preloadedState, / composeWithDevTools( applyMiddleware(...middleware), // other store enhancers if any )); or with devTools' options:javascript import { createStore, applyMiddleware } from 'redux'; import { composeWithDevTools } from 'remote-redux-devtools';

const composeEnhancers = composeWithDevTools({ realtime: true, port: 8000 }); const store = composeWithDevTools(reducer, / preloadedState, / composeEnhancers( applyMiddleware(...middleware), // other store enhancers if any )); ```

Important

In order not to allow it in production by default, the enhancer will have effect only when process.env.NODE_ENV === 'development'. In case you don't set NODE_ENV or want to use it in production, set realtime parameter to true:

js const store = createStore(reducer, devToolsEnhancer({ realtime: true }));

Monitoring

Use one of our monitor apps to inspect and dispatch actions: * web * redux-devtools-extension - Click "Remote" button (or press Cmd+Ctrl+Arrow up) to open remote monitoring. * react-native-debugger - Electron app, which already includes remotedev-server, remotedev-app and even React DevTools. * chrome app. * remote-redux-devtools-on-debugger - Used in React Native debugger as a dock monitor. * atom-redux-devtools - Used in Atom editor. * redux-dispatch-cli - A CLI tool for Redux remote dispatch.

Use remotedev-app to create your own monitor app.

Communicate via local server

In order to make it simple to use, by default, the module and the monitor app communicate via remotedev.io server. Use remotedev-server cli to run it locally in order to make the connection faster and not to require an internet connection. You can import it in your server.js script and start remotedev server together with your development server:

var remotedev = require('remotedev-server');
remotedev({ hostname: 'localhost', port: 8000 });

See remotedev-server repository for more details. For React Native you can use react-native-debugger or remote-redux-devtools-on-debugger, which already include remotedev-server.

Parameters

All parameters are optional. You have to provide at least port property to use localhost instead of remotedev.io server.

Example:

export default function configureStore(preloadedState) {
  const store = createStore(
    reducer,
    preloadedState,
    devToolsEnhancer({
      name: 'Android app', realtime: true,
      hostname: 'localhost', port: 8000,
      maxAge: 30, filters: { blacklist: ['EFFECT_RESOLVED'] },
      actionSanitizer: (action) => (
       action.type === 'FILE_DOWNLOAD_SUCCESS' && action.data ?
       { ...action, data: '<<LONG_BLOB>>' } : action
      ),
      stateSanitizer: (state) => state.data ? { ...state, data: '<<LONG_BLOB>>' } : state
    })
  );
  return store;
}

Demo

• Toggle monitoring

Examples

• Web
• React Native

License

MIT