›Introduction

Introduction

Using Redux Starter Kit

API Reference

Quick Start

Purpose

The Redux Starter Kit package is intended to help address three common concerns about Redux:

"Configuring a Redux store is too complicated"

"I have to add a lot of packages to get Redux to do anything useful"

"Redux requires too much boilerplate code"

We can't solve every use case, but in the spirit of create-react-app and apollo-boost, we can try to provide some tools that abstract over the setup process and handle the most common use cases, as well as include some useful utilities that will let the user simplify their application code.

This package is not intended to solve every possible concern about Redux, and is deliberately limited in scope. It does not address concepts like "reusable encapsulated Redux modules", data fetching, folder or file structures, managing entity relationships in the store, and so on.

That said, these tools should be beneficial to all Redux users. Whether you're a brand new Redux user setting up your
first project, or an experienced user who wants to simplify an existing application, Redux Starter Kit can help
you make your Redux code better.

What's Included

Redux Starter Kit includes:

A configureStore() function with simplified configuration options. It can automatically combine your slice reducers, adds whatever Redux middleware you supply, includes redux-thunk by default, and enables use of the Redux DevTools Extension.

A createReducer() utility that lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses the immer library to let you write simpler immutable updates with normal mutative code, like state.todos[3].completed = true.

A createAction() utility that returns an action creator function for the given action type string. The function itself has toString() defined, so that it can be used in place of the type constant.

A createSlice() function that accepts a set of reducer functions, a slice name, and an initial state value, and automatically generates corresponding action creators, types, and simple selector functions.

Installation

Redux Starter Kit is available as a package on NPM for use with a module bundler or in a Node application:

npm install --save redux-starter-kit

It is also available as a precompiled UMD package that defines a window['redux-starter-kit'] global variable.
The UMD package can be used as a <script> tag directly.

Help and Discussion

The #redux channel of the Reactiflux Discord community is our official resource for all questions related to learning and using Redux. Reactiflux is a great place to hang out, ask questions, and learn - come join us!