redux-devtools README

The project's README from github.com/reduxjs/redux-devtools. As one markdown file: README.md.

GitHub Workflow Status PRs Welcome OpenCollective OpenCollective

Redux DevTools

Developer Tools to power-up Redux development workflow or any other architecture which handles the state change (see integrations).

It can be used as a browser extension (for Chrome, Edge and Firefox), as a standalone app or as a React component integrated in the client app.

image

Documentation

Development

This is a monorepo powered by pnpm. Install pnpm and run pnpm install to get started. Each package's dependencies need to be built before the package itself can be built. You can either build all the packages (i.e., pnpm run build:all) or use pnpm workspace commands to build only the packages necessary for the packages you're working on (i.e., pnpm --filter "remotedev-redux-devtools-extension" build).

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

License

MIT

redux-devtools (reduxjs/redux-devtools)

redux
Searching Database…

What is this?Redux DevTools is a developer tools suite for Redux (or any architecture that handles state changes) that lets you inspect every dispatched action, replay actions, and hot reload your app's state.
Is this a browser extension or a library I add to my code?Both: it ships as a browser extension for Chrome, Edge and Firefox, and it can also be used as a standalone app or as a React component integrated directly into your app.
How do I get it set up in my project?Install the browser extension from the store for your browser and it will auto-detect a Redux store, or follow the Manual Integration as a React Component docs to embed the DevTools component directly in your app.
Do I need to build every package to work on one part of it?No, you can build just the packages you need using pnpm workspace filter commands instead of building the whole monorepo.
Does it only work with Redux?It's built around Redux's architecture but the README notes it also supports other state-management architectures via integrations.
Can I monitor a Redux app running on a different device or in a non-browser environment?Yes, the docs include a Remote monitoring guide for inspecting state outside a local browser tab.
What happens if the extension does not detect my store?There is a dedicated Troubleshooting doc in the README's documentation list for diagnosing connection issues.
Is there guidance beyond basic install, like common patterns?Yes, the README links to a Recipes doc and an FAQ for more advanced usage patterns.
Creator
reduxjs
Size
36.4 MB
Stars
14.4K
Age
11y
Commits · 90 Days