Skip to content

mhanki/Clean-React

Repository files navigation

clean react logo


Clean React is a CLI tool that removes and modifies some of the boilerplate files that are generated when initiating a new project with Create React App.

The tool is designed to provide a clean and minimalistic code base to your new project. It will first check to make sure you actually are in a Create React App project, and then proceed to delete and overwrite files based on these templates.

Clean React supports cleanup for both default Create React App templates (JavaScript and TypeScript).

Please note: This is just a quick helper tool. If you find yourself wanting to create and use your own custom template from the get-go, you can actually do so via Create React App itself. Find more information here.

Installation

Please install the package globally

npm install -g @mhanki/clean-react

Usage

From the root of your project, simply run the command:

clean-react

If you already modified one or more of the files that Clean React tries to rewrite, it will prompt you with a warning and ask if you want to keep the changes before it proceeds.