|
1 | | -# React Redux |
2 | | - |
3 | | -Official React bindings for [Redux](https://github.com/reduxjs/redux). |
4 | | -Performant and flexible. |
5 | | - |
6 | | - [](https://www.npmjs.com/package/react-redux) |
7 | | -[](https://www.npmjs.com/package/react-redux) |
8 | | -[](http://www.reactiflux.com) |
9 | | - |
10 | | -## Installation |
11 | | - |
12 | | -### Using Create React App |
13 | | - |
14 | | -The recommended way to start new apps with React Redux is by using the [official Redux+JS/TS templates](https://github.com/reduxjs/cra-template-redux) for [Create React App](https://github.com/facebook/create-react-app), which takes advantage of [Redux Toolkit](https://redux-toolkit.js.org/). |
15 | | - |
16 | | -```sh |
17 | | -# JS |
18 | | -npx create-react-app my-app --template redux |
19 | | - |
20 | | -# TS |
21 | | -npx create-react-app my-app --template redux-typescript |
22 | | -``` |
23 | | - |
24 | | -### An Existing React App |
25 | | - |
26 | | -React Redux 8.0 requires **React 16.8.3 or later** (or React Native 0.59 or later). |
27 | | - |
28 | | -To use React Redux with your React app, install it as a dependency: |
29 | | - |
30 | | -```bash |
31 | | -# If you use npm: |
32 | | -npm install react-redux |
33 | | - |
34 | | -# Or if you use Yarn: |
35 | | -yarn add react-redux |
36 | | -``` |
37 | | - |
38 | | -You'll also need to [install Redux](https://redux.js.org/introduction/installation) and [set up a Redux store](https://redux.js.org/recipes/configuring-your-store/) in your app. |
39 | | - |
40 | | -This assumes that you’re using [npm](http://npmjs.com/) package manager |
41 | | -with a module bundler like [Webpack](https://webpack.js.org/) or |
42 | | -[Browserify](http://browserify.org/) to consume [CommonJS |
43 | | -modules](https://webpack.js.org/api/module-methods/#commonjs). |
44 | | - |
45 | | -If you don’t yet use [npm](http://npmjs.com/) or a modern module bundler, and would rather prefer a single-file [UMD](https://github.com/umdjs/umd) build that makes `ReactRedux` available as a global object, you can grab a pre-built version from [cdnjs](https://cdnjs.com/libraries/react-redux). We _don’t_ recommend this approach for any serious application, as most of the libraries complementary to Redux are only available on [npm](http://npmjs.com/). |
46 | | - |
47 | | -## Documentation |
48 | | - |
49 | | -The React Redux docs are published at **https://react-redux.js.org** . |
50 | | - |
51 | | -## How Does It Work? |
52 | | - |
53 | | -The post [The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/) |
54 | | -explains what it does, how it works, and how the API and implementation have evolved over time. |
55 | | - |
56 | | -There's also a [Deep Dive into React-Redux](https://blog.isquaredsoftware.com/2019/06/presentation-react-redux-deep-dive/) talk that covers some of the same material at a higher level. |
57 | | - |
58 | | -## License |
59 | | - |
60 | | -[MIT](LICENSE.md) |
| 1 | +# React Redux |
| 2 | + |
| 3 | +Official React bindings for [Redux](https://github.com/reduxjs/redux). |
| 4 | +Performant and flexible. |
| 5 | + |
| 6 | + [](https://www.npmjs.com/package/react-redux) |
| 7 | +[](https://www.npmjs.com/package/react-redux) |
| 8 | +[](http://www.reactiflux.com) |
| 9 | + |
| 10 | +## Installation |
| 11 | + |
| 12 | +### Using Create React App |
| 13 | + |
| 14 | +The recommended way to start new apps with React Redux is by using the [official Redux+JS/TS templates](https://github.com/reduxjs/cra-template-redux) for [Create React App](https://github.com/facebook/create-react-app), which takes advantage of [Redux Toolkit](https://redux-toolkit.js.org/). |
| 15 | + |
| 16 | +```sh |
| 17 | +# JS |
| 18 | +npx create-react-app my-app --template redux |
| 19 | + |
| 20 | +# TS |
| 21 | +npx create-react-app my-app --template redux-typescript |
| 22 | +``` |
| 23 | + |
| 24 | +### An Existing React App |
| 25 | + |
| 26 | +React Redux 8.0 requires **React 16.8.3 or later** (or React Native 0.59 or later). |
| 27 | + |
| 28 | +To use React Redux with your React app, install it as a dependency: |
| 29 | + |
| 30 | +```bash |
| 31 | +# If you use npm: |
| 32 | +npm install react-redux |
| 33 | + |
| 34 | +# Or if you use Yarn: |
| 35 | +yarn add react-redux |
| 36 | +``` |
| 37 | + |
| 38 | +You'll also need to [install Redux](https://redux.js.org/introduction/installation) and [set up a Redux store](https://redux.js.org/recipes/configuring-your-store/) in your app. |
| 39 | + |
| 40 | +This assumes that you’re using [npm](http://npmjs.com/) package manager |
| 41 | +with a module bundler like [Webpack](https://webpack.js.org/) or |
| 42 | +[Browserify](http://browserify.org/) to consume [CommonJS |
| 43 | +modules](https://webpack.js.org/api/module-methods/#commonjs). |
| 44 | + |
| 45 | +If you don’t yet use [npm](http://npmjs.com/) or a modern module bundler, and would rather prefer a single-file [UMD](https://github.com/umdjs/umd) build that makes `ReactRedux` available as a global object, you can grab a pre-built version from [cdnjs](https://cdnjs.com/libraries/react-redux). We _don’t_ recommend this approach for any serious application, as most of the libraries complementary to Redux are only available on [npm](http://npmjs.com/). |
| 46 | + |
| 47 | +## Documentation |
| 48 | + |
| 49 | +The React Redux docs are published at **https://react-redux.js.org** . |
| 50 | + |
| 51 | +## How Does It Work? |
| 52 | + |
| 53 | +The post [The History and Implementation of React-Redux](https://blog.isquaredsoftware.com/2018/11/react-redux-history-implementation/) |
| 54 | +explains what it does, how it works, and how the API and implementation have evolved over time. |
| 55 | + |
| 56 | +There's also a [Deep Dive into React-Redux](https://blog.isquaredsoftware.com/2019/06/presentation-react-redux-deep-dive/) talk that covers some of the same material at a higher level. |
| 57 | + |
| 58 | +## License |
| 59 | + |
| 60 | +[MIT](LICENSE.md) |
0 commit comments