nmpascal-react-cli

CLI tool for generating a React-Vite application with Sass boilerplate

Installation

To use nmpascal-react-cli, make sure you have Node.js installed on your machine. Then, you can install the CLI globally using npm:

npm install -g nmpascal-react-cli

Usage

Create a new project

To create a new React-Vite application with Sass boilerplate, run the following command:

npx nmpascal-react-cli <project-name>

OR

npx nmpascal-react-cli

Replace <project-name> with the desired name for your project. This will generate a new directory with the specified project name, containing the boilerplate code.

Install dependencies

After creating a new project, navigate to the project directory and install the dependencies using npm:

cd <project-name>

then

npm install

OR

yarn

Run the project

To run the project, use the following command:

npm run dev -or- yarn dev

Features

• Sets up a React-Vite application with Sass support.
• Provides a basic folder structure and starter files.
• Includes a sample component and styles to get you started.

Project Structure

<project-name>/
  ├── public/
  │   └── vite.svg
  │
  ├── src/
  │   ├── components/
  │   │   ├── index.ts
  │   │   └── Welcome.tsx
  │   ├── helpers/
  │   │   ├── index.ts
  │   │   └── SettingsHelper.ts
  │   ├── interfaces/
  │   │   ├── index.ts
  │   │   └── ISettingsHelperProps.ts
  │   ├── styles/
  │   │   ├── components/
  │   │   │   └── Welcome.module.scss
  │   │   ├── _globals.scss
  │   │   ├── _keyframes_.scss
  │   │   ├── mixins.scss
  │   │   ├── _variables.scss
  │   │   ├── App.module.scss
  │   │   └── main.module.scss
  │   ├── utils/
  │   │   ├── constants.ts
  │   │   └── index.ts
  │   ├── App.tsx
  │   ├── main.tsx
  │   └──vite-env.d.ts
  │   
  ├── .eslintrc.js
  ├── .gitignore
  ├── index.html
  ├── package.json
  ├── tsconfig.json
  ├── tsconfig.node.json
  ├── vite.config.tsv
  └── yarn.lock