cli-web-tool v1.0.0

CLI Web Tool

Overview

CLI Web Tool is a Node.js-based command-line interface (CLI) tool designed to streamline project scaffolding for React, Next.js (including FSD architecture), and modular boilerplates. It simplifies the setup process by automating folder structures, dependency installations, and project configurations, ensuring consistency and reducing the initial development overhead.

Features

• React Project Scaffolding: Quickly set up React projects using Vite.
• Next.js Project Scaffolding: Initialize Next.js projects, with support for the latest app router.
• Next.js (FSD) Scaffolding: Build projects with the Feature-Sliced Design architecture.
• Custom Templates: Generate scaffold templates tailored to your specifications.
• Modular Boilerplates: Create modular project structures.
• TypeScript Support: Seamlessly enable TypeScript for your projects.
• Integrated Dependency Management: Automatically installs required dependencies.

Installation

To install the tool globally:

npm install -g cli-web-tool

Usage

Run the CLI tool with the following command:

npx cli-web-tool

Steps:

1. Enter your desired project name.
2. Choose the project type:
   • React Project
   • Next.js Project
   • Next.js Project (FSD)
   • Scaffold-template
   • Scaffold-modular-boilerplate
3. Follow the prompts for additional configurations (e.g., TypeScript).

Project Types

React Project

• Uses Vite for better performance and simplicity.
• Automatically installs dependencies and sets up the project.

Next.js Project

• Sets up a standard Next.js project using the latest app router.
• Compatible with TypeScript.

Next.js Project (FSD)

• Implements Feature-Sliced Design (FSD) architecture:
  • src/entities/ for domain-specific logic.
  • src/features/ for reusable features.
  • src/widgets/ for UI widgets.
  • src/shared/ for utilities and shared modules.

Scaffold-template

• Creates a custom project structure with:
  • src/ folder.
  • Webpack and Babel configurations.
  • CSS, HTML, and entry files.

Scaffold-modular-boilerplate

• Generates a modular boilerplate from pre-defined templates.

Dependencies

• chalk: For styled console outputs.
• inquirer: For interactive CLI prompts.
• child_process: To execute shell commands.
• fs and path: For file and directory operations.

Contribution

Feel free to contribute to the CLI Web Tool by submitting pull requests or reporting issues on the GitHub repository.

Support

For any questions or support, please reach out to the author:

• Author: Ejaz Ahmad
• Email: ejaz.ahmad@rakbank.ae