Have ideas to improve npm?Join in the discussion! »

    simple-react-redux

    1.0.0 • Public • Published

    simple-redux-react

    Getting the average app running with React, Redux, react-redux, redux-devtools, and react-router-redux, is getting way too complicated. I'm glad that it's so flexible and customizable but all of my projects follow a similar pattern when getting things going.

    This project doesn't solve all edge cases... for those you can wire it up yourself or submit a PR if you think this is missing a commong config.

    • Wires up React, Redux & redux-router
    • Included Redux Dev Tools (only in devel/debug mode)
    • Includes Generic Logger
    • Config to opt-out of these features (react-router opt out for RN coming soon)

    Installation

    npm install simple-redux-react --save

    Configuration

    The most common cases are implied but can be overridden. Here's the most common case. The Redux dev tools and logger middlware are included by default (more can be added too, see customizing).

    While the above snippet gets a router working and redux up, you'll need at least one reducer to do any real work.

    import {registerRedux} from './simple-react-redux'
     
    export const {dispatch} = registerRedux({
      routes: require('./routes'),
      renderToElementId: 'react-root',
      reducers: {
        app:   require('./reducers/app'),
        posts: require('./reducers/posts'),
      },
    });

    Customizing

    You'll want to add reducers and middleware at some point so you can add those as needed.

    import {registerRedux} from 'simple-react-redux'
     
    export const {dispatch} = registerRedux({
      // default options are overridable
      debug: false,                      // turns redux-devtools and logging on/off
      renderToElementId: 'react-root',
      disableLoggingMiddleware: false,
      disableDevTools: false,            // turns off redux-devtools middleware
      disableLogger: false,
      
      // pass in Routes component
      routes: require('./routes'),
      
      // router reducer is already included, add more as needed
      reducers: {
        app:   require('./reducers/app'),
        posts: require('./reducers/posts'),
      },
     
      // optioally add your own middleware
      middleware: [
        myCustomMiddleware(),
      ],
    });

    Exports

    Sometimes you'll need access to the store or the Root view. You can use these:

    const {store, dispatch, Root} = registerRedux(...);

    Install

    npm i simple-react-redux

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • avatar