node-setup-cli/README.md

A CLI tool to bootstrap Node.js project with commom packages

 CLI tool to quickly bootstrap Node.js projects with common packages like Express, dotenv, CORS, Mongoose, and optional TypeScript support.  

---


## Features

- Initialize a new Node.js project (npm init -y)  
- Install essential packages (express, dotenv, cors, mongoose)  
- Optionally setup *TypeScript* with a tsconfig.json  
- Create a ready-to-use .env file  
- Generate a basic server file (index.js or index.ts)  
- Interactive prompts to choose project name, packages, and language  
- Works on Windows, Mac, and Linux  

---


## Installation

### Option 1: Using npx (Recommended)

No global installation required. Always uses the latest version.

```bash
npx node-setup-cli

## Installation

### Option 1: Using npx (Recommended)

No global installation required. Always uses the latest version.

```bash
npx node-setup-cli

Option 2: Global Installation

Allows you to run the CLI from anywhere.

npm i -g node-setup-cli
node-setup-cli

> ⚠ Windows users: If you get a permission error:

Open Command Prompt / PowerShell as Administrator, or

Use npx node-setup-cli instead.

---


Usage

Option 1: Using npx

1. Navigate to your project folder:

cd path/to/projects

2. Run the CLI:

npx node-setup-cli

3. Follow the interactive prompts:

Enter project name

Choose packages to install (express, dotenv, cors, mongoose)

Select JavaScript or TypeScript

---


Option 2: Using Global Installation

1. Ensure node-setup-cli is installed globally:

npm i -g node-setup-cli

2. Navigate to your project folder:

cd path/to/projects

3. Run the CLI:

node-setup-cli

4. Follow the interactive prompts:

Enter project name

Choose packages to install

Select JavaScript or TypeScript

---


Example Interactive Flow

? Enter your project name: my-node-app
? Select packages to install: (Use space to select, enter to confirm)
  ❯◯ express
   ◯ dotenv
   ◯ cors
   ◯ mongoose
? Choose language: JavaScript / TypeScript

JavaScript: generates index.js

TypeScript: generates index.ts, installs typescript + ts-node, and creates tsconfig.json

---


Generated Project Structure

my-node-app/
├── index.js or index.ts   # Basic server file
├── package.json           # NPM project file
├── tsconfig.json          # Only if TypeScript selected
├── .env                   # Environment variables file
└── node_modules/          # Installed packages

---


Running the Server

# JavaScript
node index.js

# TypeScript
npx ts-node index.ts

Visit http://localhost:3000 to see Hello World!.