gc-react

gc-react is a cli tool to generate react components quickly. You can use one of the templates or add your own to cut down
on the boilerplate typing time and to reduce typos.

Installation

Choosing a template

Create a component

Delete a component

Options

Installation

1) Install the module

$3


$ npm install gc-react --save-dev


$3


$ yarn add gc-react -D


2) Add the script to your package.json file

// package.json
"scripts":{
    ...
    
    "gc":"gc"
}

Note : You can also install the module globally


$ npm install -g gc-react


Creating a component

#### Make sure to replace 'component_name' with the name of the component you want to create.

With yarn

$3


$ yarn gc create 'component_name'


With npm

$3


$ npm run gc create 'component_name'


Installed globally


$ gc create 'component_name'


Deleting a component

#### Make sure to replace 'component_name' with the name of the component you want to create.

With yarn

$3


$ yarn gc remove 'component_name'


With npm

$3


$ npm run gc remove 'component_name'


Installed globally


$ gc remove 'component_name'


Options

#### You can specify options with command line arguments and/or by creating a gc-react.config.json file at the root of your project.

#### Typing --template yourtemplate all the time gets tedious, so you should at least create the file and specify the template.

// filename : gc-react.config.json
{
    "template" : 'fireship',
}

--dry-run

$3

--quiet

$3

--global-styles

$3

Component Template

--template

$3

• fireship


• ts-globalScss


• js-nextjs


• ts-nextjs


• ts-tailwind

$3

$ gc create navbar --template fireship

$3

$3

$3

Using a gc-react.config.json file

// filename : gc-react.config.json
{
    "dryRun": boolean,
    "template" : string,
    "quiet: boolean
}

TODO

$3

$3