Skip to content

zeabdullah/react-scaffold

Repository files navigation

react-scaffold

⚛️ Scaffold your React app from the command line ⚛️.

Downloads/week Build status License

Usage & Installation

It is recommended to install react-scaffoldx globally since it makes it easier for you to quickly type out.

$ npm install -g react-scaffoldx
$ rsx COMMAND
running command...
$ rsx (--version)
react-scaffoldx/0.4.0 win32-x64 node-v16.13.1
$ rsx --help [COMMAND]
USAGE
  $ rsx COMMAND
...

Commands

rsx component

Create/Scaffold a React component. this command also has aliases, c and comp (used as rsx c ...)

USAGE
  $ rsx component [-d <value>] [--typescript] [--style css|scss|styled-components|none]

FLAGS
  -d, --dest=<value>                         Destination folder
  --style=(css|scss|styled-components|none)  Choose which type of styling to use for your components
  --typescript                               Create a TypeScript component

DESCRIPTION
  Create/Scaffold a React component
  
ALIASES
  $ rsx comp
  $ rsx c

EXAMPLES
  $ rsx component ComponentOne ComponentTwo

  $ rsx component ComponentOne --typescript --style=scss --dest src/components/layout

rsx init

Initialize react-scaffold's config file (.rsxrc)

USAGE
  $ rsx init [-y]

FLAGS
  -y, --yes  accept default config values ('assume YES')

DESCRIPTION
  Initialize react-scaffold's config file (.rsxrc)

rsx help [COMMAND]

Display help for rsx.

USAGE
  $ rsx help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

DESCRIPTION
  Display help for rsx.