node-genie/README.md

Interactive CLI tool to quickly scaffold Node.js projects with TypeScript/JavaScript support and multiple architecture options

# 🧞‍♂️ Node Genie

Interactive CLI tool to quickly scaffold Node.js projects with TypeScript/JavaScript support and multiple architecture options.

[![npm version](https://badge.fury.io/js/node-genie.svg)](https://badge.fury.io/js/node-genie)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D16.0.0-brightgreen)](https://nodejs.org/)

## ✨ Features

- 🎨 **Colored Interactive CLI** - Beautiful interface with cursor navigation
- 💻 **Language Support** - Choose between TypeScript (recommended) or JavaScript
- 🏗️ **Multiple Architectures** - Choose between MVC structure or Simple structure
- 📂 **MVC Architecture** - Full structured project with controllers, models, routes, and more
- 📁 **Simple Structure** - Single server file with basic route (no src folder)
- 🔧 **Code Quality** - Optional ESLint + Prettier setup
- 📝 **Essential Files** - Always includes .gitignore, .env template, and configuration files
- 🚀 **Ready to Run** - Complete project setup with package.json and scripts
- 📦 **Package Manager Support** - Choose between npm, yarn, or pnpm

## 🚀 Quick Start

### Installation

```bash
# Install globally via npm
npm install -g node-genie

# Or using yarn
yarn global add node-genie

# Or using pnpm
pnpm add -g node-genie
```

### Usage

```bash
# Run the interactive CLI
node-genie
```

### Development Installation

If you want to contribute or run from source:

```bash
# Clone the repository
git clone https://github.com/ayushrajput8021/node-genie.git
cd node-genie

# Install dependencies
npm install

# Link the CLI globally (for development)
npm link
```

The CLI will guide you through:

1. **Project Name** - Enter your project name
2. **Language Choice** - TypeScript (recommended) or JavaScript
3. **Architecture** - MVC structure or Simple structure
4. **Package Manager** - npm, yarn, or pnpm
5. **Code Quality** - Set up ESLint + Prettier

### Architecture Options

#### 🏗️ MVC Architecture

Full structured project with organized folders:

- `src/server.ts/js` - Main server file
- `src/app.ts/js` - Express app setup
- `src/routes/index.ts/js` - Basic routing
- `src/middlewares/auth.ts/js` - Authentication middleware
- `src/database/connection.ts/js` - Database setup
- Plus controllers, models, services, utils folders

#### 📁 Simple Structure

Minimal setup with just a server file in the root:

- `server.ts/js` - Single server file with basic route and middleware
- No src folder, perfect for quick prototypes or learning

**Always included:** `.gitignore`, `.env` template, and appropriate configuration files

## 📁 Generated Project Structure

### MVC Architecture

```bash
my-project/
├── src/
│   ├── configs/
│   │   └── index.ts/js          # Configuration management
│   ├── controllers/             # Request handlers
│   ├── database/
│   │   └── connection.ts/js     # Database connection setup
│   ├── middlewares/
│   │   └── auth.ts/js           # Authentication middleware
│   ├── models/                  # Data models
│   ├── routes/
│   │   └── index.ts/js          # API routes
│   ├── services/                # Business logic
│   ├── types/                   # TypeScript types (TS projects only)
│   ├── utils/
│   │   └── index.ts/js          # Utility functions
│   ├── app.ts/js                # Express app setup
│   └── server.ts/js             # Main server file
├── .env                         # Environment variables
├── .gitignore                   # Git ignore rules
├── .eslintrc.json              # ESLint configuration (optional)
├── .prettierrc.json            # Prettier configuration (optional)
├── tsconfig.json               # TypeScript configuration (if TS)
└── package.json                # Project dependencies and scripts
```

### Simple Structure

```bash
my-project/
├── server.ts/js                 # Single server file with route
├── .env                         # Environment variables
├── .gitignore                   # Git ignore rules
├── .eslintrc.json              # ESLint configuration (optional)
├── .prettierrc.json            # Prettier configuration (optional)
├── tsconfig.json               # TypeScript configuration (if TS)
└── package.json                # Project dependencies and scripts
```

## 📦 Generated Dependencies

### For TypeScript Projects

- **Runtime**: `express`, `dotenv`, `cors`
- **Development**: `typescript`, `@types/*`, `tsx`, `rimraf`
- **Code Quality**: `eslint`, `prettier`, `@typescript-eslint/*`

### For JavaScript Projects

- **Runtime**: `express`, `dotenv`, `cors`
- **Development**: `nodemon`
- **Code Quality**: `eslint`, `prettier`

## 🎯 Available Scripts

After project generation, you can use these scripts:

```bash
# Install dependencies (using your chosen package manager)
npm install  # or yarn install / pnpm install

# Start the server (production)
npm start

# Start development server with auto-reload
npm run dev

# Build TypeScript to JavaScript (TS projects only)
npm run build

# Clean build directory (TS projects only)
npm run clean

# Run ESLint (if enabled)
npm run lint

# Fix ESLint issues automatically (if enabled)
npm run lint:fix

# Format code with Prettier (if enabled)
npm run format
```

### Example Usage

```bash
# Create a new project
node-genie

# Navigate to your project
cd my-awesome-project

# Install dependencies
pnpm install

# Start development server
pnpm run dev

# Your server will be running at http://localhost:3000
```

## 🔧 Development

To contribute to node-genie:

```bash
# Clone and setup
git clone https://github.com/ayushrajput8021/node-genie.git
cd node-genie
npm install

# Link for local development
npm link

# Test the CLI
node-genie

# Unlink when done
npm unlink node-genie
```

### Publishing

```bash
# Update version
npm version patch  # or minor/major

# Publish to npm
npm publish
```

## 📋 Roadmap

### Phase 1 (Current) ✅

- Interactive CLI with colors
- TypeScript/JavaScript support
- MVC structure generation
- Simple structure option
- Package manager selection
- ESLint, Prettier, configs

### Phase 2 (Coming Soon)

- 🗄️ Database integration options (MongoDB, PostgreSQL, MySQL)
- 🧪 Testing framework selection (Jest, Vitest)
- 🔒 Authentication templates (JWT, Passport)
- 💾 User preference memory
- 📊 API documentation setup (Swagger)

### Phase 3 (Future)

- 🔌 Plugin system
- 👥 Team templates
- ⚙️ CI/CD configurations
- 🐳 Docker support
- ☁️ Cloud deployment templates

## 🤝 Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## 👨‍💻 Author

**Ayush Rajput**

- GitHub: [@ayushrajput8021](https://github.com/ayushrajput8021)
- Email: <ayushrajput8021@gmail.com>

## 🌟 Show your support

Give a ⭐️ if this project helped you!

## 📈 Stats

![npm](https://img.shields.io/npm/dt/node-genie)
![GitHub stars](https://img.shields.io/github/stars/ayushrajput8021/node-genie)
![GitHub forks](https://img.shields.io/github/forks/ayushrajput8021/node-genie)

## 📄 License

MIT License - see the [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgments

- Built with [Commander.js](https://github.com/tj/commander.js/), [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/), and [Chalk](https://github.com/chalk/chalk)
- Inspired by create-react-app and other scaffolding tools