🚀 VRUSHABH - Professional Project Scaffold Generator

Professional-grade CLI to scaffold 18+ production-ready project templates

╔═══════════════════════════════════════════════════════════════════════════╗
║                                                                           ║
║                  ███████╗ ██████╗ █████╗ ███████╗███████╗              ║
║                  ██╔════╝██╔════╝██╔══██╗██╔════╝██╔════╝              ║
║                  ███████╗██║     ███████║█████╗  █████╗                ║
║                  ╚════██║██║     ██╔══██║██╔══╝  ██╔══╝                ║
║                  ███████║╚██████╗██║  ██║██║     ██║                   ║
║                  ╚══════╝ ╚═════╝╚═╝  ╚═╝╚═╝     ╚═╝                   ║
║                                                                           ║
║              🚀 PROFESSIONAL PROJECT GENERATOR 🚀                        ║
║         Multi-Language • Enterprise Ready • Production Grade            ║
║                                                                           ║
╚═══════════════════════════════════════════════════════════════════════════╝

Features • Installation • Quick Start • Templates • Documentation

✨ Features

🎯 Beautiful Interactive CLI

• Stunning 3D ASCII art welcome screen with professional styling
• Smart cascading prompts that adapt to your choices
• Color-coded terminal output for better readability
• Emoji indicators for quick visual navigation
• User-friendly guidance at every step

📦 18 Professional Templates

• 6 Backend options (Node.js, Python, Go)
• 8 Frontend options (Web & Mobile frameworks)
• 4 Monorepo solutions (Enterprise-scale architectures)
• All production-ready with best practices included
• Real GitHub/GitLab repositories for templates

🔧 Intelligent Project Setup

• Multi-level selection flow (Type → Language → Framework → Stack)
• Current directory detection (use . or specify custom path)
• Automatic package manager detection (npm, yarn, pnpm recommended)
• Built-in validation at every step
• Git initialization ready

🚀 Development-Friendly

• Zero configuration needed to start
• Automatic dependency installation (optional)
• Template caching for faster scaffolding
• Enterprise patterns included (Docker, CI/CD)
• TypeScript support everywhere

🌍 Multi-Language Ecosystem

• JavaScript/TypeScript (NestJS, React, Next.js)
• Python (FastAPI, Django)
• Go (Gin framework)
• Swift & Kotlin (iOS & Android)
• Dart (Flutter)

📥 Installation

Global Installation (Recommended)

npm install -g vrushabh

Then run from anywhere:

vrushabh

Using npx (No Installation Required)

npx vrushabh

Using Yarn or pnpm

yarn global add vrushabh
# or
pnpm add -g vrushabh

⚡ Quick Start (5 Minutes)

Step 1: Run the CLI

vrushabh

You'll see our beautiful welcome banner! 🎉

Step 2: Select Project Type

? 📌 What type of project?
  🔧 Backend (API/Service)
  🎨 Frontend (Web/Mobile)
  📦 Monorepo (Multiple Services)

Step 3: Choose Directory

? 📂 Where should we create your project?
  📍 Current directory (.)
  📁 Custom path

Step 4: Select Language/Type (Context-Aware)

If Backend:

? 🔧 Backend Language
  ⚡ Node.js (NestJS, Express, Fastify)
  🐍 Python (FastAPI, Django)
  🔵 Go (Gin, Fiber, Echo)

If Frontend:

? 🎨 Frontend Type
  🌐 Web (React, Vue, Angular, Next.js)
  📱 Mobile (React Native, Flutter, Swift, Kotlin)

Step 5: Pick Your Template

? 📦 Template Selection
  🏢 NestJS Enterprise + PostgreSQL + TypeORM
     Enterprise-grade NestJS backend with PostgreSQL, TypeORM, Docker & CI/CD
  
  ⚛️  React + Vite + Tailwind CSS
     Modern React SPA with Vite, TypeScript & Tailwind CSS
  
  [More options based on your selection...]

Step 6: Configure Project

? Package name: my-awesome-project
? 📦 Package manager (pnpm recommended)
  npm
  yarn
  pnpm ← We recommend this! ⚡

Step 7: Review & Confirm

═══════════════════════════════════════════
✨ PROJECT SUMMARY
═══════════════════════════════════════════
Project Name:     my-project
Directory:        /Users/you/my-project
Package Name:     my-awesome-project
Author:           Vrushabh
License:          MIT
Scopes:           backend
Services:         1
Package Manager:  pnpm
Install Deps:     Yes
Initialize Git:   Yes
═══════════════════════════════════════════

? Proceed with scaffolding? (Yes)

Step 8: Done! 🎉

✓ Creating project structure...
✓ Downloading template from repository...
✓ Installing dependencies...
✓ Initializing git repository...

🎉 Project ready! Next steps:
  cd my-project
  pnpm dev (or npm run dev)

📦 All Available Templates

🔧 Backend Templates (6 Total)

Node.js Backend (3 templates)

| Template | Description | Repository | |----------|-------------|-----------| | 🏢 NestJS Enterprise + PostgreSQL + TypeORM ⭐ | Enterprise-grade backend with Docker & CI/CD | GitLab | | 🏗️ NestJS + Express + PostgreSQL + TypeORM | Scalable NestJS with Express adapter | GitHub | | ⚡ Express + PostgreSQL + TypeORM | Lightweight but powerful Express API | GitHub |

Python Backend (2 templates)

| Template | Description | Repository | |----------|-------------|-----------| | 🐍 FastAPI + PostgreSQL | Modern async Python API framework | GitHub | | 🎯 Django + Django REST Framework | Full-featured Django with admin panel | GitHub |

Go Backend (1 template)

| Template | Description | Repository | |----------|-------------|-----------| | ⚡ Go Gin + PostgreSQL | High-performance API framework | GitHub |

🎨 Frontend Templates (8 Total)

Web Frameworks (4 templates)

| Template | Description | Repository | |----------|-------------|-----------| | ⚛️ React + Vite + Tailwind CSS | Modern SPA with fast bundler | GitHub | | 💚 Vue 3 + Vite + Tailwind CSS | Progressive framework with DX | GitHub | | 🔴 Angular + Tailwind CSS | Full-featured framework | GitHub | | 🚀 Next.js 14 Fullstack | App Router, SSR, API routes | GitHub |

Mobile Frameworks (4 templates)

| Template | Description | Repository | |----------|-------------|-----------| | 📱 React Native + Expo | iOS & Android from one codebase | GitHub | | 🎨 Flutter | Native iOS & Android performance | GitHub | | 🍎 Swift iOS | Native iOS with SwiftUI | GitHub | | 🤖 Kotlin Android | Native Android with Jetpack Compose | GitHub |

📦 Monorepo Templates (4 Total)

| Template | Description | Use Case | |----------|-------------|----------| | 📦 NestJS Monorepo (Nx) | Multiple NestJS services + shared libs | Backend scale | | 🏗️ Turborepo | Fast monorepo with caching | General purpose | | 🚀 NestJS + React (Nx) | Fullstack backend + frontend | Fullstack teams | | 🌐 Next.js + API (Turborepo) | Next.js frontend + API routes | Next.js focused |

🎯 Which Template Should I Choose?

📋 Decision Guide

For Enterprise Backend?

✅ Use: NestJS Enterprise + PostgreSQL + TypeORM
Why: Production-ready, your custom template, includes Docker & CI/CD

For Startup MVP?

✅ Use: Next.js 14 Fullstack
Why: Full-stack in one, less infrastructure, fast to market

For Web Only?

✅ Use: React + Vite + Tailwind (if you have backend already)
    or Next.js 14 Fullstack (if you need backend)
Why: Modern tooling, fast development

For Mobile App?

✅ Use: React Native + Expo (if small team, quick turnaround)
    or Flutter (if you want native performance)
Why: Cross-platform, code reuse

For Large Team/Multiple Services?

✅ Use: NestJS Monorepo (Nx) or Fullstack (NestJS + React)
Why: Scalable, shared code, organized structure

For Python Backend?

✅ Use: FastAPI (if modern async, fast)
    or Django (if admin panel, full-featured needed)
Why: Python ecosystem, easy learning

📚 Complete Documentation

How the CLI Works

1. Interactive Flow

Start
  ↓
[Beautiful Welcome Banner]
  ↓
Choose Project Type (Backend/Frontend/Monorepo)
  ↓
[Smart Decision Tree - only relevant questions]
  ↓
Select Template (auto-filtered)
  ↓
Configure Details
  ↓
Review Summary
  ↓
Scaffold Project ✨

2. Project Setup Flow

Backend Path:

Backend → Language Selection → Framework Templates → Stack Options
├─ Node.js → NestJS/Express → PostgreSQL + TypeORM
├─ Python → FastAPI/Django → PostgreSQL
└─ Go → Gin → PostgreSQL

Frontend Path:

Frontend → Web or Mobile
├─ Web → React/Vue/Angular/Next.js → Select template
└─ Mobile → React Native/Flutter/Swift/Kotlin → Select template

Monorepo Path:

Monorepo → Backend + Frontend → Nx or Turborepo → Configuration

3. Post-Generation

After scaffolding, your project includes:

• ✅ Project structure with best practices
• ✅ TypeScript configuration
• ✅ Dependency management
• ✅ Git initialization
• ✅ README with next steps
• ✅ Development setup guide

🛠️ Advanced Usage

Using Current Directory

vrushabh
# When prompted for directory:
# Select "Current directory" option
# Project scaffolds in current location

Specifying Package Manager

vrushabh
# When asked for package manager:
# Select 'pnpm' (recommended, faster, more secure)
# npm or yarn if needed

Skip Dependency Installation

vrushabh
# When asked "Install dependencies?"
# Select 'No' to skip
# Run 'pnpm install' or 'npm install' manually later

Initialize Git Later

vrushabh
# When asked "Initialize Git?"
# Select 'No'
# Run 'git init' manually later

🔧 System Requirements

| Requirement | Version | |------------|---------| | Node.js | ≥ 18.0.0 | | npm/yarn/pnpm | Latest recommended | | Git | Latest (for git initialization) | | Operating System | macOS, Linux, Windows |

📖 Examples

Example 1: Create Enterprise Backend

$ vrushabh
  ↓ Select: Backend
  ↓ Select: Node.js
  ↓ Select: NestJS Enterprise + PostgreSQL + TypeORM
  ↓ Enter: my-api
  ↓ Select: pnpm
  ↓ Confirm: Yes
  
✨ Your enterprise backend is ready!

Example 2: Create Fullstack Project

$ vrushabh
  ↓ Select: Frontend
  ↓ Select: Web
  ↓ Select: Next.js 14 Fullstack
  ↓ Enter: my-app
  ↓ Select: pnpm
  ↓ Confirm: Yes

✨ Fullstack project with Next.js ready!

Example 3: Create Mobile App

$ vrushabh
  ↓ Select: Frontend
  ↓ Select: Mobile
  ↓ Select: React Native + Expo
  ↓ Enter: my-mobile-app
  ↓ Select: pnpm
  ↓ Confirm: Yes

✨ Mobile project ready for iOS & Android!

🚀 After Project Generation

First Steps

cd my-project

# Install dependencies (if not auto-installed)
pnpm install

# Start development
pnpm dev

# Open in browser (if applicable)
# Usually http://localhost:3000 or http://localhost:3001

Common Commands

Development

pnpm dev        # Start development server
pnpm start      # Start production server
pnpm build      # Build for production

Testing & Quality

pnpm test       # Run tests
pnpm lint       # Check code quality
pnpm format     # Format code with Prettier

Git & Deployment

git status      # Check changes
git commit -m "message"  # Commit changes
git push        # Push to repository

❓ Frequently Asked Questions

Q: Do I need to install this globally?

A: No! You can use npx vrushabh without installation. Global install is optional for convenience.

Q: Can I modify templates after creation?

A: Yes! Each generated project is fully editable. Templates are just starting points.

Q: Which package manager should I use?

A: We recommend pnpm (faster, more secure, better disk usage). npm and yarn work fine too.

Q: Can I add custom templates?

A: Yes! Edit src/templates/templates.json and add your own template entries.

Q: Is my data saved or tracked?

A: No! Everything runs locally on your machine. No data is sent anywhere.

Q: What about Node.js version compatibility?

A: Requires Node.js 18+. We test with LTS versions.

Q: Can I contribute templates?

A: Yes! Submit a PR with your template configuration on GitHub.

Q: How do I uninstall?

npm uninstall -g vrushabh

🐛 Troubleshooting

Issue: "Command not found: vrushabh"

Solution:

# Install globally
npm install -g vrushabh

# Or use npx
npx vrushabh

Issue: "Permission denied" errors

Solution:

# Run from a directory where you have write permissions
cd ~/Projects
vrushabh

Issue: Templates not downloading

Solution:

# Check internet connection
# Verify repository URLs are accessible
# Try again - first download is slower

Issue: pnpm not found

Solution:

# Install pnpm globally
npm install -g pnpm

# Or use npm/yarn instead when prompted

Issue: Port already in use

Solution:

# When running 'pnpm dev', it will suggest alternative port
# Or kill the process using that port

📊 Technology Stack

Supported Languages & Frameworks

🔷 Node.js/JavaScript
   ├─ Backend:  NestJS, Express, Fastify
   ├─ Web:      React, Vue, Angular, Next.js
   └─ Mobile:   React Native, Expo

🔶 Python
   ├─ FastAPI  (Async APIs)
   └─ Django   (Full Framework)

🔵 Go
   └─ Gin      (High-Performance APIs)

☕ Java/Kotlin
   └─ Android  (Jetpack Compose)

🍎 Swift
   └─ iOS      (SwiftUI)

🎨 Dart
   └─ Flutter  (Cross-Platform)

Databases & Tools

🗄️  Databases:  PostgreSQL, MongoDB, MySQL, Redis
📝 ORMs:        TypeORM, Prisma, SQLAlchemy, GORM
🐳 DevOps:      Docker, Docker Compose, Kubernetes-ready
🔄 CI/CD:       GitHub Actions, GitLab CI, Jenkins templates

💡 Pro Tips

1. Use pnpm — It's faster and more secure than npm
2. Start with current directory — Use . to scaffold in current folder
3. Check template README — Each template has its own documentation
4. Review auto-generated files — Understand the structure before modifying
5. Keep git clean — Commit before making changes
6. Use TypeScript — All templates include TS by default
7. Read framework docs — Know the framework you're using

🔗 Useful Links

Official Documentation

• Node.js - JavaScript runtime
• NestJS - Backend framework
• React - Frontend library
• Next.js - Full-stack framework
• FastAPI - Python async API
• Django - Python framework
• Flutter - Mobile framework

Template Repositories

• Your NestJS Enterprise - Production-ready NestJS
• All others are from official framework repos

Tools & Resources

• pnpm - Package manager
• TypeScript - Language
• Prettier - Code formatter
• ESLint - Code linter

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.

You are free to use this tool for personal, commercial, or any other purpose.

👨‍💻 Author

Vrushabh — Building tools that make developers' lives easier ❤️

About This Tool

This CLI was created to solve the problem of starting new projects quickly without repeating boilerplate setup. Instead of spending hours configuring a new project, you can now:

• ✅ Choose your tech stack
• ✅ Get a production-ready template
• ✅ Start coding in minutes
• ✅ Follow best practices automatically

Get Involved

• ⭐ Star this repo if you find it helpful
• 🐛 Report issues on GitHub
• 💡 Suggest new templates
• 📝 Contribute to documentation
• 🚀 Share with other developers

🙏 Acknowledgments

This tool is built on top of amazing open-source projects:

• Enquirer - Interactive prompts
• Chalk - Terminal colors
• Ora - Loading spinners
• Axios - HTTP client
• All framework & template creators 🙌

🎉 Get Started Now!

# Install
npm install -g vrushabh

# Run
vrushabh

# Enjoy! 🚀

Made with ❤️ by Vrushabh

Professional project scaffolding for modern developers

GitHub • npm • Documentation