@sachin-thakur/create-nodejs-app 1.0.0

package/src/utils/readme.js

@@ -0,0 +1,277 @@
+function generateReadme(projectName, config) {
+  const isTypeScript = config.language === "typescript";
+
+  return `# ${projectName}
+
+A production-ready ${config.projectType.toUpperCase()} application built with Node.js and ${
+    isTypeScript ? "TypeScript" : "JavaScript"
+  }.
+
+## 🚀 Features
+
+- ⚡ **${
+    config.language === "typescript" ? "TypeScript" : "JavaScript"
+  }** - Type safety and modern syntax
+- 🏗️ **${config.architecture.toUpperCase()} Architecture** - Clean and maintainable code structure
+${
+  config.database !== "none"
+    ? `- 🗄️ **${
+        config.database.charAt(0).toUpperCase() + config.database.slice(1)
+      }** - Database integration`
+    : ""
+}
+${
+  config.features.includes("auth")
+    ? "- 🔐 **JWT Authentication** - Secure user authentication"
+    : ""
+}
+${
+  config.features.includes("validation")
+    ? "- ✅ **Request Validation** - Input validation with Zod"
+    : ""
+}
+${
+  config.features.includes("logging")
+    ? "- 📝 **Logging** - Structured logging with Winston"
+    : ""
+}
+${
+  config.features.includes("swagger")
+    ? "- 📚 **API Documentation** - Auto-generated Swagger docs"
+    : ""
+}
+${
+  config.features.includes("rate-limit")
+    ? "- 🛡️ **Rate Limiting** - API rate limiting protection"
+    : ""
+}
+${
+  config.features.includes("cors")
+    ? "- 🌐 **CORS** - Cross-origin resource sharing configuration"
+    : ""
+}
+${
+  config.features.includes("cache")
+    ? "- ⚡ **Redis Caching** - Fast data caching"
+    : ""
+}
+${
+  config.features.includes("jobs")
+    ? "- 🔄 **Background Jobs** - Task queue with Bull"
+    : ""
+}
+${
+  config.features.includes("email")
+    ? "- 📧 **Email Service** - Email sending with Nodemailer"
+    : ""
+}
+${
+  config.features.includes("file-upload")
+    ? "- 📁 **File Upload** - File upload handling"
+    : ""
+}
+${
+  config.testing !== "none"
+    ? `- 🧪 **Testing** - Unit and integration tests with ${
+        config.testing.charAt(0).toUpperCase() + config.testing.slice(1)
+      }`
+    : ""
+}
+${config.docker ? "- 🐳 **Docker** - Containerization ready" : ""}
+${config.cicd ? "- 🔄 **CI/CD** - GitHub Actions workflow" : ""}
+
+## 📋 Prerequisites
+
+- Node.js >= 16.x
+- npm or yarn
+${config.database === "postgresql" ? "- PostgreSQL >= 13.x" : ""}
+${config.database === "mongodb" ? "- MongoDB >= 5.x" : ""}
+${config.database === "mysql" ? "- MySQL >= 8.x" : ""}
+${
+  config.features.includes("cache") || config.features.includes("jobs")
+    ? "- Redis >= 6.x"
+    : ""
+}
+${config.docker ? "- Docker and Docker Compose (optional)" : ""}
+
+## 🛠️ Installation
+
+1. Clone the repository:
+\`\`\`bash
+git clone <repository-url>
+cd ${projectName}
+\`\`\`
+
+2. Install dependencies:
+\`\`\`bash
+npm install
+\`\`\`
+
+3. Set up environment variables:
+\`\`\`bash
+cp .env.example .env
+\`\`\`
+Edit the \`.env\` file with your configuration.
+
+${
+  config.database !== "none"
+    ? `4. Set up the database:
+\`\`\`bash
+# Create database
+${
+  config.database === "postgresql"
+    ? "createdb myapp_db"
+    : config.database === "mongodb"
+    ? "# MongoDB will create the database automatically"
+    : "# Create MySQL database"
+}
+\`\`\`
+`
+    : ""
+}
+
+## 🚀 Running the Application
+
+### Development mode:
+\`\`\`bash
+npm run dev
+\`\`\`
+
+### Production mode:
+\`\`\`bash
+${isTypeScript ? "npm run build\n" : ""}npm start
+\`\`\`
+
+${
+  config.docker
+    ? `### Using Docker:
+\`\`\`bash
+docker-compose up
+\`\`\`
+`
+    : ""
+}
+
+The application will be running at \`http://localhost:3000\`
+
+${
+  config.features.includes("swagger")
+    ? `## 📚 API Documentation
+
+Once the server is running, visit:
+- Swagger UI: \`http://localhost:3000/api-docs\`
+`
+    : ""
+}
+
+## 🧪 Testing
+
+${
+  config.testing !== "none"
+    ? `Run tests:
+\`\`\`bash
+npm test
+\`\`\`
+
+Run tests in watch mode:
+\`\`\`bash
+npm run test:watch
+\`\`\`
+
+Generate coverage report:
+\`\`\`bash
+npm run test:coverage
+\`\`\`
+`
+    : "Testing framework not included. Add your preferred testing framework."
+}
+
+## 📁 Project Structure
+
+\`\`\`
+${projectName}/
+├── src/
+${
+  config.architecture === "mvc"
+    ? `│   ├── config/          # Configuration files
+│   ├── controllers/     # Request handlers
+│   ├── models/          # Data models
+│   ├── routes/          # API routes
+│   ├── middlewares/     # Custom middlewares
+│   ├── services/        # Business logic
+│   ├── utils/           # Utility functions
+│   └── index.${isTypeScript ? "ts" : "js"}         # Application entry point`
+    : ""
+}
+${
+  config.architecture === "clean"
+    ? `│   ├── domain/          # Business entities
+│   ├── application/     # Use cases
+│   ├── infrastructure/  # External services
+│   ├── presentation/    # Controllers & routes
+│   └── index.${isTypeScript ? "ts" : "js"}         # Application entry point`
+    : ""
+}
+${
+  config.architecture === "feature-based"
+    ? `│   ├── features/        # Feature modules
+│   ├── shared/          # Shared utilities
+│   ├── config/          # Configuration
+│   └── index.${isTypeScript ? "ts" : "js"}         # Application entry point`
+    : ""
+}
+├── tests/               # Test files
+${
+  isTypeScript
+    ? "├── dist/               # Compiled JavaScript (generated)\n"
+    : ""
+}├── .env.example         # Environment variables template
+├── .gitignore
+├── package.json
+${isTypeScript ? "├── tsconfig.json       # TypeScript configuration\n" : ""}${
+    config.docker ? "├── Dockerfile\n├── docker-compose.yml\n" : ""
+  }└── README.md
+\`\`\`
+
+## 🔧 Available Scripts
+
+- \`npm start\` - Start production server
+- \`npm run dev\` - Start development server with hot reload
+${
+  isTypeScript ? "- `npm run build` - Build for production\n" : ""
+}- \`npm run lint\` - Run ESLint
+- \`npm run lint:fix\` - Fix ESLint errors
+- \`npm run format\` - Format code with Prettier
+${
+  config.testing !== "none"
+    ? "- `npm test` - Run tests\n- `npm run test:watch` - Run tests in watch mode\n- `npm run test:coverage` - Generate coverage report"
+    : ""
+}
+
+## 🌍 Environment Variables
+
+See \`.env.example\` for all available environment variables.
+
+## 🤝 Contributing
+
+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
+
+This project is licensed under the MIT License.
+
+## 👨‍💻 Author
+
+Your Name
+
+## 🙏 Acknowledgments
+
+- Generated with [create-nodejs-app](https://github.com/yourusername/create-nodejs-app)
+`;
+}
+
+module.exports = { generateReadme };

package/test.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+# Quick test script for create-nodejs-app
+# This script tests the CLI by creating a sample project
+
+echo "🧪 Testing create-nodejs-app CLI..."
+echo ""
+
+# Create a temporary directory
+TEST_DIR="/tmp/test-create-nodejs-app-$(date +%s)"
+mkdir -p "$TEST_DIR"
+cd "$TEST_DIR"
+
+echo "📁 Test directory: $TEST_DIR"
+echo ""
+
+# Run the CLI (you'll need to answer the prompts)
+echo "🚀 Running CLI..."
+echo "Please answer the prompts to create a test project"
+echo ""
+
+node /home/claude/create-nodejs-app/bin/cli.js test-project
+
+# Check if project was created
+if [ -d "test-project" ]; then
+    echo ""
+    echo "✅ Project created successfully!"
+    echo ""
+    echo "📦 Project structure:"
+    tree -L 2 test-project/ || ls -la test-project/
+    echo ""
+    echo "📄 Files created:"
+    find test-project -type f | head -20
+    echo ""
+    echo "🎉 Test completed! Check the project at: $TEST_DIR/test-project"
+else
+    echo ""
+    echo "❌ Project creation failed!"
+    exit 1
+fi