# redux-generator-cli

> Boilerplate for redux with redux toolkit

Latest version **1.0.6** (published 2024-03-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install redux-generator-cli
pnpm add redux-generator-cli
yarn add redux-generator-cli
bun add redux-generator-cli
```

Provides the commands `redux-init`, `redux-generate`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2024-03-20 |
| First published | 2024-03-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 53.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Marko Popovic |
| Maintainers | nimmly |
| Keywords | react, redux, @reduxjs/toolkit, createAsyncThunk, createSlice, store, dispatch, selector, reducer, typescript |

## Links

- npm: https://www.npmjs.com/package/redux-generator-cli
- Repository: https://github.com/Nimmly/redux-generator-cli
- Homepage: https://github.com/Nimmly/redux-generator-cli#readme
- Issues: https://github.com/Nimmly/redux-generator-cli/issues
- npm.io page: https://npm.io/package/redux-generator-cli

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^1.6.8
- [typescript](https://npm.io/package/typescript.md) ^5.4.2
- [@types/node](https://npm.io/package/@types/node.md) ^20.11.27
- [react-redux](https://npm.io/package/react-redux.md) ^9.1.0
- [@reduxjs/toolkit](https://npm.io/package/@reduxjs/toolkit.md) ^2.2.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2024-03-20
- 1.0.5 — 2024-03-18
- 1.0.4 — 2024-03-15
- 1.0.3 — 2024-03-14
- 1.0.2 — 2024-03-14
- 1.0.1 — 2024-03-14
- 1.0.0 — 2024-03-14

## README

### Boilerplate type safe generator for redux using redux-toolkit and axios

## Features

- Initialize redux and redux/toolkit inside your project
- Generate Actions, Slice, Types files for the given name

## Installing
> npm i -g redux-generator-cli


## Usage
Go to your root folder of a project and run

>redux-init

It will install [axios](https://www.npmjs.com/package/axios), [react-redux](https://www.npmjs.com/package/react-redux)
and [redux-toolkit](https://www.npmjs.com/package/@reduxjs/toolkit) inside your project.
Also, it will generate folder redux with basic TypeScript implementation of redux (store,hooks,reducer) and default 
state types/values (loading,status,error).

>redux-generate --name=<NAME_OF_YOUR_CHOICE>

It will generate folders, "NAME_OF_YOUR_CHOICE" and hooks

- NAME_OF_YOUR_CHOICE.actions.ts
- NAME_OF_YOUR_CHOICE.slice.ts
- NAME_OF_YOUR_CHOICE.types.ts
- hooks/use<NAME_OF_YOUR_CHOICE>Hook.ts

All the files will have to be updated based on your specifications and requirements, starting with
NAME_OF_YOUR_CHOICE.types.ts

## Folder structure example

![folder-structure](https://github.com/Nimmly/redux-generator-cli/blob/main/assets/folder-structure.png)

---
_Source: https://npm.io/package/redux-generator-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._