https://github.com/ghoshnirmalya/building-redux-from-scratch

Building Redux from scratch
https://github.com/ghoshnirmalya/building-redux-from-scratch

javascript javascript-library react react-redux reactjs redux redux-store

Last synced: 10 days ago
JSON representation

Building Redux from scratch

• Host: GitHub
• URL: https://github.com/ghoshnirmalya/building-redux-from-scratch
• Owner: ghoshnirmalya
• License: mit
• Created: 2018-10-03T18:50:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-19T09:05:44.000Z (7 months ago)
• Last Synced: 2024-12-26T22:02:13.967Z (19 days ago)
• Topics: javascript, javascript-library, react, react-redux, reactjs, redux, redux-store
• Language: JavaScript
• Size: 1.15 MB
• Stars: 16
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# My Redux

[![Build Status](https://travis-ci.org/ghoshnirmalya/building-redux-from-scratch.svg?branch=master)](https://travis-ci.org/ghoshnirmalya/building-redux-from-scratch)

This app demonstrates how you can build your own version of [Redux](https://redux.js.org/). [my-redux-example](https://github.com/ghoshnirmalya/my-redux-example) is an app which is using this package to maintain it's state. You can view the whole implementation in [this file](https://github.com/ghoshnirmalya/my-redux-example/blob/master/src/App.js).



## Example usage

#### Step 1: Import the createStore function from my-redux into your app

```js

import createStore from "my-redux";

```

#### Step 2: Create a reducer function

```js

const reducer = (state = initialState, action) =>

  action.type === "INCREMENT"

    ? { count: state.count + action.payload.count }

    : state;

```

#### Step 3: Pass that reducer function to the createStore function along with the initialState of your app

```js

this.store = createStore(reducer, { count: 0 });

```

#### Step 4: Dispatch an action to update your store

```js

this.store.dispatch({

  type: "INCREMENT",

  payload: {

    count: 1

  }

});

```

You store should now reflect the updated state. You can verify that by logging the state of your store:

```js

console.log(this.store.getState());

```

[my-redux-example](https://github.com/ghoshnirmalya/my-redux-example) is an app which is using this package to maintain it's state. You can view the whole implementation in [this file](https://github.com/ghoshnirmalya/my-redux-example/blob/master/src/App.js).

## Development

```sh

$ git clone https://github.com/ghoshnirmalya/my-redux

$ cd my-redux

$ yarn install

```

#### Running the tests

```sh

$ yarn test

```

#### Getting the test coverage

```sh

$ yarn coverage

```

#### Building the code

```sh

$ yarn build

```

#### Publish

```sh

$ yarn version patch|minor|major

$ yarn publish

```

It'll automatically run `test`, `docs`, `build` and generate CHANGELOG.md file.

## License

MIT © [Nirmalya Ghosh](https://github.com/ghoshnirmalya)