Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 3.56 KB

README.md

File metadata and controls

87 lines (57 loc) · 3.56 KB
Raw

flow-react-cli

npm NPM npm

logo

Documentation

About flow-react-cli

This CLI program is a package that creates the boilerplate and components needed to develop React. Using flow-react-cli, you can increase the productivity of React.

The two main features of this CLI program are as follows:

  1. Create a React or Next.js project that has completed the installation and setup of the Typescip, EsLint, Prettier, and CSS libraries (styled-components or Tailwind CSS).
  2. When you create a functional component page, you can create a page where the boilerplate was created.

📢 Notes

This program was inspired by dooboo-cli and created by referring to the code in the dooboo-cli.

The difference between flow-react-cli and dooboo-cli is shown below.

  1. When you create a project, you can automatically update and use the most recent update of the packages that have dependencies.
  2. When you create a React project, you can install the CSS library together.
  3. You can create any project when you create a component. This means that you can create components, even if they are not projects created using that package.
  4. When creating a project or component, there is no restriction on

flow-react-cli updates packages for dependencies using the npm-check-updates package when you create or update a project.

Installation

npm install -g flow-react-cli or yarn global add flow-react-cli

Usage

Usage: flow [command]

Options:
  -V, --version               output the version number
  -h, --help                  display help for command

Commands:
  init                        Initialize the React or Next.js project, including the Boilerplate.
  update                      Use the npm-check-updates package to update the package in the project.
  page <fileName> <filePath>  Generate page(screen) component.
  help [command]              display help for command

Preview

preview

Patch Notes (Version 1.1.x)

When entering the flow init command, you can create an empty Node project that contains the Boilerplate of TypeScript, EsLint, and Prettier.

Contributing to flow-react-cli

I am working hard to develop this package with affection. I check all the requests and issues. I'm not a JavaScript developer. There are many parts of this package that are lacking.

This package needs your help.

Please write about the code and if you have a better code, please revise it and contribute.

Please upload the idea or bug for package function development on the issue.

I like all discussions related to development because I am in a learning position.

If you have any further questions or need to contact me, please email [email protected].

Thank you for using my package and for your interest.

"Buy Me A Coffee"