# react-quick-builder

> A CLI tool to help you quickly build React applications and React Components.

Latest version **1.0.2** (published 2023-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-quick-builder
pnpm add react-quick-builder
yarn add react-quick-builder
bun add react-quick-builder
```

Provides the command `react-quick-builder`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-05-12 |
| First published | 2023-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 23.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Muhammad Asim masim5722@gmail.com |
| Maintainers | masim5722 |
| Keywords | react, quick, builder |

## Links

- npm: https://www.npmjs.com/package/react-quick-builder
- Repository: https://github.com/masim5722/react-quick-builder
- Homepage: https://github.com/masim5722/react-quick-builder#readme
- Issues: https://github.com/masim5722/react-quick-builder/issues
- npm.io page: https://npm.io/package/react-quick-builder

## Dependencies (9)

- [redux](https://npm.io/package/redux.md) ^4.1.1
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [commander](https://npm.io/package/commander.md) ^10.0.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [react-redux](https://npm.io/package/react-redux.md) ^7.2.4
- [redux-thunk](https://npm.io/package/redux-thunk.md) ^2.3.0
- [react-scripts](https://npm.io/package/react-scripts.md) ^4.0.3
- [create-react-app](https://npm.io/package/create-react-app.md) ^5.0.1
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.2.0

## 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.2 (latest) — 2023-05-12
- 1.0.1 — 2023-04-06
- 1.0.0 — 2023-04-06

## README

# React Quick Builder

React Quick Builder is a command-line interface tool that helps you create a new React application with a standardized folder structure. It includes Redux, React Router, and Material-UI.
This is the very first version of this command line tool. In this version you can create the boilder plate for your application and create new components using the component command.

## Installation

You can install React Quick Builder using NPM. Make sure you have NPM installed on your machine before running the following command:

```
npm install -g react-quick-builder
```

Note: If you're getting permission issues, make sure to run the command using administrative privileges.

## Getting Started

After installing React Quick Builder, you can use it to create a new React application with the following command:

```lua
react-quick-builder create-app my-app
```

This will create a new React application with the folder structure shown below:

```javascript
my-app/
├── node_modules/
├── public/
│   ├── index.html
│   ├── favicon.ico
│   └── manifest.json
├── src/
│   ├── components/
│   │   ├── App/
│   │       └── index.js
│   │   └── Home/
│   │       ├── index.js
│   │       └── Home.jsx
│   │       └── styles.js
│   ├── constants/
│   │       └── appRoutes.js
│   ├── pages/
│   │   └── Home/
│   │       ├── HomePage.jsx
│   │       └── styles.js
│   ├── routes/
│   │       └── appRoutes.js
│   ├── redux/
│   │       └── rootReducer.js
│   │       └── store.js
│   ├── utils/
│   │   └── hooks/
│   ├── index.js
│   ├── reportWebVitals.js
│   └── setupTests.js
├── .gitignore
├── README.md
├── package-lock.json
└── package.json
```

## Creating a Component

You can also create a new component using the following command:

```lua
react-quick-builder create-component MyComponent
```

This will create a new component named **`MyComponent`** in the **`src/components`** folder.


## Examples

```bash
# Create a new React app
react-quick-builder create-app my-app

# Create a new component
react-quick-builder create-component MyComponent
```

## Contributing

We welcome contributions from the community! Please feel free to create a pull request if you have any suggestions or improvements for the project.
## What's in the version 2.0

Our focus is to provide couple of different commands by using which you can create the boilerplate code of the component which can include redux, routes or both. 
There will be other commands to create the hooks.
Our ultimate goals is to reduce the time and efforts which the developer spent on creating the standarized coding structure and basic structure for their components against modules and features.

Some example from Version 2.0
```bash
# Create a new component with routes
react-quick-builder create-component MyComponent --routes

# Create a new component with Redux
react-quick-builder create-component MyComponent --redux

# Create a new component with routes and Redux
react-quick-builder create-component MyComponent --routes --redux

# Create a new hook
react-quick-builder create-hook HookName

# Create a Restful APIs (GET, PUT, PATCH, POST and DELETE)
react-quick-builder create-service ServiceName --restful
```

## License 

This project is licensed under the MIT License. 

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/masim5722/react-quick-builder/blob/main/LICENSE)

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