Overview:
React Scaffolder is a Yeoman generator for scaffolding new React applications. It is a homegrown React template generator that allows users to build their own React + Webpack configuration. The tool is open source and provides users with the ability to generate new React templates with various features and options.
Features:
- Rendering: client-side only
- Syntax: React, JavaScript, JSX, TypeScript, TSX
- Tooling: ESLint, Stylelint, Editorconfig, Babel (non-TypeScript template only)
- Styling: SCSS, CSS, PostCSS, CSS module syntax (*.module.scss and *.module.css nomenclature supported)
- Testing: Jest, React Testing Library
- Build instructions: provided via the README.md file generated with each new scaffold
Installation:
To use the React Scaffolder, follow these steps:
- Make sure you have the required version of Node installed (default version >= 16.13.1).
- Install the Yeoman generator by running the following command:
npm install -g yo
- Install the React Scaffolder generator by running either of the following commands:
For NPM users:
npm install -g generator-react-scaffolder
For Yarn users (version ^1.22.4):
yarn global add generator-react-scaffolder
- Once the generator is installed, you can scaffold a new React template by running the following command:
yo react-scaffolder
- You will be prompted to provide an application name and select whether to use Yarn or not.
Summary:
React Scaffolder is a Yeoman generator that allows users to easily scaffold new React applications with customizable features and options. It provides rendering, syntax, tooling, styling, and testing capabilities, as well as build instructions for each new scaffolded template. The tool is open source and supports the latest versions of Node and NPM/Yarn. It does not include script ejection or environment variable implementation, and it is not tested in Internet Explorer.