@sachin-thakur/create-nodejs-app 1.0.0

package/DEVELOPMENT.md

@@ -0,0 +1,183 @@
+# Development Guide
+
+## Testing the CLI Locally
+
+### 1. Link the CLI tool globally
+
+From the `create-nodejs-app` directory:
+
+```bash
+npm link
+```
+
+This creates a global symlink to your CLI tool.
+
+### 2. Test the CLI
+
+Now you can run your CLI from anywhere:
+
+```bash
+create-nodejs-app test-app
+```
+
+Or using the full command:
+
+```bash
+node /path/to/create-nodejs-app/bin/cli.js test-app
+```
+
+### 3. Test in a separate directory
+
+```bash
+cd /tmp
+create-nodejs-app my-test-project
+cd my-test-project
+npm install
+npm run dev
+```
+
+### 4. Unlink when done testing
+
+```bash
+npm unlink -g create-nodejs-app
+```
+
+## Publishing to npm
+
+### 1. Create an npm account
+
+If you don't have one: https://www.npmjs.com/signup
+
+### 2. Login to npm
+
+```bash
+npm login
+```
+
+### 3. Update package.json
+
+Make sure your package.json has:
+- Unique name (check on npmjs.com)
+- Correct version
+- Your information in author field
+- Repository URL
+
+### 4. Test the package
+
+```bash
+npm pack
+```
+
+This creates a .tgz file. You can test install it:
+
+```bash
+npm install -g ./create-nodejs-app-1.0.0.tgz
+```
+
+### 5. Publish
+
+```bash
+npm publish
+```
+
+For first publish of a scoped package:
+```bash
+npm publish --access public
+```
+
+### 6. Update versions
+
+When you make changes:
+
+```bash
+# Patch version (1.0.0 -> 1.0.1)
+npm version patch
+
+# Minor version (1.0.0 -> 1.1.0)
+npm version minor
+
+# Major version (1.0.0 -> 2.0.0)
+npm version major
+
+# Then publish
+npm publish
+```
+
+## Project Structure
+
+```
+create-nodejs-app/
+├── bin/
+│   └── cli.js              # CLI entry point
+├── src/
+│   ├── generator.js        # Main project generator
+│   ├── templates/          # Code templates
+│   │   ├── index.js
+│   │   ├── mvc.js         # MVC architecture
+│   │   ├── clean.js       # Clean architecture
+│   │   └── featureBased.js
+│   └── utils/             # Utility functions
+│       ├── packageJson.js
+│       ├── envFile.js
+│       ├── readme.js
+│       ├── docker.js
+│       └── cicd.js
+├── package.json
+└── README.md
+```
+
+## Adding New Features
+
+### Add a new project type
+
+1. Edit `bin/cli.js` - add option to projectType choices
+2. Update templates to handle the new type
+
+### Add a new architecture
+
+1. Create new file in `src/templates/` (e.g., `hexagonal.js`)
+2. Implement the structure generation
+3. Export the function
+4. Import and use in `src/templates/index.js`
+
+### Add a new feature
+
+1. Update `bin/cli.js` - add to features choices
+2. Update `src/utils/packageJson.js` - add dependencies
+3. Update `src/utils/envFile.js` - add environment variables
+4. Update template files to include the feature
+
+## Tips
+
+- Test thoroughly before publishing
+- Use semantic versioning
+- Keep a CHANGELOG.md
+- Write good commit messages
+- Tag releases in git
+- Monitor issues and pull requests
+
+## Common Issues
+
+### Permission denied
+
+```bash
+chmod +x bin/cli.js
+```
+
+### Module not found
+
+Make sure all requires/imports are correct and files exist.
+
+### npm link not working
+
+Try:
+```bash
+npm unlink
+npm link
+```
+
+Or globally:
+```bash
+npm unlink -g create-nodejs-app
+npm link -g
+```

package/README.md

@@ -0,0 +1,238 @@
+# Create Production Node App
+
+🚀 A powerful CLI tool to scaffold **production-ready** Node.js applications with modern best practices, complete with TypeScript support, database integration, authentication, testing, and more.
+
+## ✨ Features
+
+Unlike other scaffolding tools that give you a basic "Hello World" template, **Create Production App** generates applications that are ready for production deployment with:
+
+- 🎯 **Multiple Project Types**: REST API, GraphQL API, Microservices, CLI Tools
+- 📐 **Architecture Patterns**: MVC, Clean Architecture, Feature-based (Modular)
+- 💎 **TypeScript or JavaScript**: Full TypeScript support with strict mode
+- 🗄️ **Database Integration**: PostgreSQL, MongoDB, MySQL with connection pooling
+- 🔐 **Authentication**: JWT-based auth with bcrypt password hashing
+- ✅ **Request Validation**: Input validation with Zod
+- 📝 **Logging**: Structured logging with Winston
+- 📚 **API Documentation**: Auto-generated Swagger/OpenAPI docs
+- 🛡️ **Security**: Rate limiting, CORS, helmet, input sanitization
+- ⚡ **Caching**: Redis integration for performance
+- 📧 **Email Service**: Nodemailer setup for transactional emails
+- 📁 **File Upload**: Multer configuration for file handling
+- 🔄 **Background Jobs**: Bull queue for async task processing
+- 🧪 **Testing**: Jest, Vitest, or Mocha with example tests
+- 🐳 **Docker**: Complete Docker and docker-compose setup
+- 🔄 **CI/CD**: GitHub Actions workflow configured
+- 📦 **ESLint & Prettier**: Code quality and formatting
+
+## 🚀 Quick Start
+
+### Using npx (Recommended)
+
+```bash
+npx create-nodejs-app my-awesome-app
+```
+
+### Using npm
+
+```bash
+npm install -g create-nodejs-app
+create-nodejs-app my-awesome-app
+```
+
+### Using yarn
+
+```bash
+yarn global add create-nodejs-app
+create-nodejs-app my-awesome-app
+```
+
+## 📖 Usage
+
+Simply run the command and follow the interactive prompts:
+
+```bash
+npx create-nodejs-app my-app
+```
+
+You'll be asked to choose:
+
+1. **Project Type**: REST API, GraphQL API, Microservice, or CLI Tool
+2. **Language**: TypeScript (recommended) or JavaScript
+3. **Architecture**: MVC, Clean Architecture, or Feature-based
+4. **Database**: PostgreSQL, MongoDB, MySQL, or None
+5. **Features**: 
+   - Authentication (JWT)
+   - API Documentation (Swagger)
+   - Request Validation
+   - Error Handling & Logging
+   - Rate Limiting
+   - CORS Configuration
+   - File Upload
+   - Email Service
+   - Caching (Redis)
+   - Background Jobs
+6. **Testing Framework**: Jest, Vitest, Mocha, or None
+7. **Docker**: Include Docker configuration
+8. **CI/CD**: Include GitHub Actions workflow
+
+## 📦 What You Get
+
+After running the CLI, you'll have a fully structured project:
+
+```
+my-app/
+├── src/
+│   ├── config/          # Configuration files
+│   │   ├── database.ts  # Database connection
+│   │   ├── logger.ts    # Winston logger setup
+│   │   └── swagger.ts   # Swagger configuration
+│   ├── controllers/     # Request handlers
+│   ├── models/          # Database models
+│   ├── routes/          # API routes with Swagger docs
+│   ├── middlewares/     # Custom middlewares (auth, validation, error handling)
+│   ├── services/        # Business logic layer
+│   ├── utils/           # Utility functions
+│   └── index.ts         # Application entry point
+├── tests/               # Test files
+├── .github/
+│   └── workflows/       # CI/CD configuration
+├── Dockerfile           # Docker configuration
+├── docker-compose.yml   # Multi-container setup
+├── .env.example         # Environment variables template
+├── .gitignore
+├── .eslintrc.json       # ESLint configuration
+├── .prettierrc          # Prettier configuration
+├── tsconfig.json        # TypeScript configuration (if TS)
+├── package.json
+└── README.md            # Project-specific README
+```
+
+## 🎯 Example Projects
+
+### REST API with PostgreSQL
+
+```bash
+npx create-nodejs-app my-api
+# Select: REST API, TypeScript, MVC, PostgreSQL
+# Select features: Auth, Validation, Logging, Swagger, Rate Limiting, CORS
+# Select: Jest, Docker, CI/CD
+```
+
+This generates a production-ready REST API with:
+- JWT authentication
+- PostgreSQL database with connection pooling
+- Request validation with Zod
+- Comprehensive error handling
+- Swagger API documentation
+- Rate limiting and CORS
+- Docker setup with PostgreSQL container
+- CI/CD pipeline with GitHub Actions
+
+### Microservice with MongoDB
+
+```bash
+npx create-nodejs-app user-service
+# Select: Microservice, TypeScript, Clean Architecture, MongoDB
+# Select features: Auth, Validation, Logging, Caching, Background Jobs
+# Select: Jest, Docker, CI/CD
+```
+
+## 🔧 Development
+
+After creating your project:
+
+```bash
+cd my-app
+npm install
+cp .env.example .env
+# Edit .env with your configuration
+npm run dev
+```
+
+Your app will be running at `http://localhost:3000`
+
+If you included Swagger, visit: `http://localhost:3000/api-docs`
+
+## 🐳 Using Docker
+
+If you included Docker configuration:
+
+```bash
+docker-compose up
+```
+
+This will start your application along with the database and any other services (Redis, etc.)
+
+## 🧪 Testing
+
+```bash
+npm test                 # Run tests
+npm run test:watch       # Watch mode
+npm run test:coverage    # Coverage report
+```
+
+## 🏗️ Architecture Patterns
+
+### MVC (Model-View-Controller)
+Traditional and straightforward. Great for most REST APIs and web applications.
+
+### Clean Architecture (Layered)
+Domain-driven with clear separation of concerns. Ideal for complex business logic and enterprise applications.
+
+### Feature-based (Modular)
+Organized by features rather than technical layers. Perfect for microservices and scalable applications.
+
+## 🤔 Why Create Production App?
+
+Most Node.js scaffolding tools give you a basic structure, but lack:
+
+- ❌ Proper error handling patterns
+- ❌ Logging configuration
+- ❌ Security best practices
+- ❌ Database setup with migrations
+- ❌ Authentication implementation
+- ❌ API documentation
+- ❌ Testing examples
+- ❌ Docker and CI/CD setup
+
+**Create Production App** provides all of this out of the box, so you can focus on building features instead of boilerplate.
+
+## 📚 Documentation
+
+For more detailed information, check out:
+
+- [API Development Guide](docs/api-guide.md)
+- [Database Setup](docs/database.md)
+- [Authentication](docs/authentication.md)
+- [Testing Guide](docs/testing.md)
+- [Deployment](docs/deployment.md)
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📝 License
+
+MIT License - see [LICENSE](LICENSE) file for details
+
+## 🙏 Acknowledgments
+
+Built with ❤️ to help developers ship production-ready applications faster.
+
+## 🐛 Issues
+
+Found a bug or have a feature request? Please open an issue on [GitHub](https://github.com/yourusername/create-nodejs-app/issues).
+
+## ⭐ Star Us!
+
+If you find this tool helpful, please consider giving it a star on GitHub!
+
+---
+
+**Happy coding! 🚀**

package/bin/cli.js

@@ -0,0 +1,177 @@
+#!/usr/bin/env node
+
+const { program } = require("commander");
+const chalk = require("chalk");
+const ora = require("ora");
+const path = require("path");
+const fs = require("fs-extra");
+const validateProjectName = require("validate-npm-package-name");
+const { generateProject } = require("../src/generator");
+
+program
+  .version("1.0.0")
+  .argument("[project-name]", "Name of the project")
+  .description("Create a production-ready Node.js application")
+  .action(async (projectName) => {
+    // ✅ FIX: Dynamic import for Inquirer (ESM-only)
+    const inquirer = (await import("inquirer")).default;
+
+    console.log(chalk.bold.cyan("\n🚀 Welcome to Create Production App!\n"));
+
+    // Get project name if not provided
+    if (!projectName) {
+      const answers = await inquirer.prompt([
+        {
+          type: "input",
+          name: "projectName",
+          message: "What is your project name?",
+          default: "my-app",
+          validate: (input) => {
+            const validation = validateProjectName(input);
+            if (validation.validForNewPackages) {
+              return true;
+            }
+            return validation.errors?.[0] || "Invalid project name";
+          },
+        },
+      ]);
+
+      projectName = answers.projectName;
+    }
+
+    // Validate project name
+    const validation = validateProjectName(projectName);
+    if (!validation.validForNewPackages) {
+      console.error(
+        chalk.red(`\n❌ Invalid project name: ${validation.errors?.[0]}\n`)
+      );
+      process.exit(1);
+    }
+
+    const projectPath = path.resolve(process.cwd(), projectName);
+
+    // Check if directory already exists
+    if (fs.existsSync(projectPath)) {
+      console.error(
+        chalk.red(`\n❌ Directory "${projectName}" already exists!\n`)
+      );
+      process.exit(1);
+    }
+
+    // Interactive prompts
+    const config = await inquirer.prompt([
+      {
+        type: "list",
+        name: "projectType",
+        message: "What type of project do you want to create?",
+        choices: [
+          { name: "REST API", value: "rest-api" },
+          { name: "GraphQL API", value: "graphql-api" },
+          { name: "Microservice", value: "microservice" },
+          { name: "CLI Tool", value: "cli" },
+        ],
+        default: "rest-api",
+      },
+      {
+        type: "list",
+        name: "language",
+        message: "Which language do you want to use?",
+        choices: [
+          { name: "TypeScript (Recommended)", value: "typescript" },
+          { name: "JavaScript", value: "javascript" },
+        ],
+        default: "typescript",
+      },
+      {
+        type: "list",
+        name: "architecture",
+        message: "Choose your project architecture:",
+        choices: [
+          { name: "MVC (Model-View-Controller)", value: "mvc" },
+          { name: "Clean Architecture (Layered)", value: "clean" },
+          { name: "Feature-based (Modular)", value: "feature-based" },
+        ],
+        default: "mvc",
+      },
+      {
+        type: "list",
+        name: "database",
+        message: "Which database do you want to use?",
+        choices: [
+          { name: "PostgreSQL", value: "postgresql" },
+          { name: "MongoDB", value: "mongodb" },
+          { name: "MySQL", value: "mysql" },
+          { name: "None", value: "none" },
+        ],
+        default: "postgresql",
+      },
+      {
+        type: "checkbox",
+        name: "features",
+        message: "Select additional features:",
+        choices: [
+          { name: "Authentication (JWT)", value: "auth", checked: true },
+          {
+            name: "API Documentation (Swagger)",
+            value: "swagger",
+            checked: true,
+          },
+          { name: "Request Validation", value: "validation", checked: true },
+          { name: "Error Handling & Logging", value: "logging", checked: true },
+          { name: "Rate Limiting", value: "rate-limit", checked: true },
+          { name: "CORS Configuration", value: "cors", checked: true },
+          { name: "File Upload", value: "file-upload" },
+          { name: "Email Service", value: "email" },
+          { name: "Caching (Redis)", value: "cache" },
+          { name: "Background Jobs", value: "jobs" },
+        ],
+      },
+      {
+        type: "list",
+        name: "testing",
+        message: "Which testing framework?",
+        choices: [
+          { name: "Jest", value: "jest" },
+          { name: "Vitest", value: "vitest" },
+          { name: "Mocha + Chai", value: "mocha" },
+          { name: "None", value: "none" },
+        ],
+        default: "jest",
+      },
+      {
+        type: "confirm",
+        name: "docker",
+        message: "Include Docker configuration?",
+        default: true,
+      },
+      {
+        type: "confirm",
+        name: "cicd",
+        message: "Include CI/CD configuration (GitHub Actions)?",
+        default: true,
+      },
+    ]);
+
+    // Generate project
+    const spinner = ora("Creating your project...").start();
+
+    try {
+      await generateProject(projectName, projectPath, config);
+      spinner.succeed(chalk.green("Project created successfully!"));
+
+      console.log(chalk.bold.cyan("\n📦 Next steps:\n"));
+      console.log(`  cd ${projectName}`);
+      console.log("  npm install");
+      console.log("  cp .env.example .env");
+      console.log("  # Configure your .env file");
+      console.log("  npm run dev");
+
+      console.log(chalk.bold.cyan("\n✨ Happy coding!\n"));
+    } catch (error) {
+      spinner.fail(chalk.red("Failed to create project"));
+      console.error(chalk.red(error.message));
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@sachin-thakur/create-nodejs-app",
+  "version": "1.0.0",
+  "description": "A CLI tool to scaffold production-ready Node.js applications with best practices",
+  "main": "index.js",
+  "bin": {
+    "create-nodejs-app": "./bin/cli.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "cli",
+    "scaffolding",
+    "nodejs",
+    "typescript",
+    "boilerplate",
+    "production-ready",
+    "api",
+    "rest",
+    "starter"
+  ],
+  "author": "Your Name",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^11.1.0",
+    "inquirer": "^9.2.12",
+    "chalk": "^4.1.2",
+    "ora": "^5.4.1",
+    "fs-extra": "^11.2.0",
+    "validate-npm-package-name": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}