nodejs-quickstart-structure 1.19.0 → 2.0.0

package/LICENSE

@@ -1,15 +1,15 @@
-ISC License
-
-Copyright (c) 2026, Pau Dang
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ISC License
+
+Copyright (c) 2026, Pau Dang
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -5,12 +5,36 @@
 [![npm monthly downloads](https://img.shields.io/npm/dm/nodejs-quickstart-structure.svg?style=flat-square)](https://www.npmjs.com/package/nodejs-quickstart-structure)
 [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg?style=flat-square)](https://opensource.org/licenses/ISC)
 
-A powerful CLI tool to scaffold production-ready Node.js microservices with built-in best practices, allowing you to choose between **MVC** or **Clean Architecture**, **JavaScript** or **TypeScript**, and your preferred database.
+### 📈 Real-world Adoption
+| **Metric** | **Insight** |
+| :--- | :--- |
+| 🔥 **4,000+** | Downloads on npm |
+| 🚀 **1,200+** | Recent GitHub Clones |
+| 🌍 **Trusted by** | Devs from **Google**, **Viblo**, and global tech teams |
+
+---
+
+A powerful CLI tool to scaffold production-ready Node.js microservices with built-in best practices. Choose between **MVC** or **Clean Architecture**, **JavaScript** or **TypeScript**, and your preferred tech stack in seconds.
+
+🎯 **[Try the Next-Gen Web UI Configurator!](https://paudang.github.io/nodejs-quickstart-structure/)**
+*Generate your exact architecture in the browser with real-time folder simulation.*
 
 ![Demo](docs/demo.gif)
 
 ---
 
+## 🆕 What's New in v2.0.0
+
+The v2.0.0 release is a major leap forward, turning the generator into a **Community Standard** for Node.js development:
+
+- **Next-Gen Web UI Configurator**: A modern, browser-based visual project simulator. Click your stack and copy the generated zero-prompt CLI command instantly! [Try it here](https://paudang.github.io/nodejs-quickstart-structure/).
+- **🦾 AI-Native Foundation**: Built-in `.cursorrules` and Agent skills optimized for **Cursor** & AI coding assistants.
+- **🏗️ Enterprise Clean Architecture**: High-fidelity structure for professional Microservices (TS/JS).
+- **🛡️ Hardened Security**: Integrated Snyk & SonarCloud logic in the core templates.
+- **⚡ Zero-Prompt Workflow**: Generate projects with a single CLI command—no more answering prompts manually.
+
+---
+
 ## 📌 Table of Contents
 
 - [🚀 Quick Start](#-quick-start)
@@ -53,7 +77,6 @@ nodejs-quickstart init
 - **Communication Patterns**: Supports **REST**, **GraphQL** (Apollo), and **Kafka** (Event-driven).
 - **Multi-layer Caching**: Integrated **Redis** or built-in **Memory Cache**.
 - **AI-Native Optimized**: specifically designed for **Cursor** and AI agents, including built-in `.cursorrules` and Agent Skill prompts. 🚀
-- **Next Gen Web UI**: (Coming Soon) A modern, browser-based project selector featuring real-time virtualization — set for release in v2.0.0!
 
 ---
 
@@ -100,8 +123,7 @@ The CLI will guide you through:
 ---
 
 ## 🏗️ Generated Project Structure
-
-A typical generated project (TypeScript + Clean Architecture) looks like this:
+Depending on your choices, the structure adapts. Here is a **TypeScript + Clean Architecture** preview:
 
 ```text
 .
@@ -111,12 +133,13 @@ A typical generated project (TypeScript + Clean Architecture) looks like this:
 │   ├── infrastructure/  # DB, External services, Repositories
 │   ├── interfaces/      # Controllers, Routes, GraphQL, Kafka
 │   ├── errors/          # Custom Error Classes
-│   └── index.ts         # Entry point
+│   ├── config/          # Environment & Global settings
+│   └── index.ts         # Server entry point
 ├── flyway/sql/          # SQL migrations (if applicable)
 ├── docker-compose.yml   # Infrastructure services
 ├── package.json         # Scripts and dependencies
-├── tsconfig.json        # TypeScript config
-└── .cursorrules         # AI assistance rules
+├── .cursorrules         # AI assistance rules (The "AI Brain")
+└── .env.example         # Environment template
 ```
 
 ---
@@ -130,9 +153,9 @@ For full guides, architecture deep-dives, and feature references, visit our **[O
 ## ❤️ Support & 🗺️ Roadmap
 
 ### Support the Project
-We just hit **3,000+ downloads**! If this tool helped you, please:
-- Give us a ⭐ on [GitHub](https://github.com/paudang/nodejs-quickstart-structure).
-- Read our [Medium Article](https://medium.com/@paudang/nodejs-quickstart-generator-93c276d60e0b) for tutorials.
+If this tool helped you build your project faster, please support us:
+- Give us a ⭐ on [GitHub](https://github.com/paudang/nodejs-quickstart-structure) to help us reach our next milestone!
+- Read our [Medium Series](https://medium.com/@paudang/nodejs-quickstart-generator-93c276d60e0b) for architecture deep-dives.
 
 ### Roadmap
 Track our progress and vote for features on our public board:
@@ -140,6 +163,18 @@ Track our progress and vote for features on our public board:
 
 ---
 
+## ⭐ Why Star us?
+
+We are on a mission to build the best AI-Native Node.js scaffolding experience. Your star is not just a "like"—it's a vote of confidence that helps us:
+
+1. **Attract Contributors**: More stars attract professional maintainers to keep this project secure and up-to-date.
+2. **AI Model Awareness**: Popular repositories are weighted higher by AI coding assistants (Cursor, Copilot, etc.), making the generated code even better.
+3. **Open Source Sustainability**: It motivates us to keep building and shipping "Enterprise-Grade" features for free.
+
+If this tool saved you hours of work, **[please give us a Star!](https://github.com/paudang/nodejs-quickstart-structure)** 🚀
+
+---
+
 ## License
 
 ISC

package/bin/index.js

@@ -31,6 +31,7 @@ program
     .option('-c, --communication <communication>', 'Communication (REST APIs, GraphQL, Kafka)')
     .option('--ci-provider <provider>', 'CI/CD Provider (None, GitHub Actions, Jenkins, GitLab CI)')
     .option('--include-security', 'Include Enterprise Security Hardening')
+    .option('--no-include-security', 'Exclude Enterprise Security Hardening')
     .option('--caching <type>', 'Caching Layer (None/Redis)')
     .action(async (options) => {
         // Fix for Commander camelCase conversion
@@ -74,7 +75,12 @@ program
             
             console.log(chalk.cyan(`\nNext steps:\n  cd ${answers.projectName}\n  npm install\n  docker-compose up\n-----------------------${manualStartInstructions}\n\n${chalk.yellow('Production (PM2):')}\n  npm run build\n  npm run deploy\n  npx pm2 logs`));
 
-            console.log(chalk.yellow(`\n⭐ If this tool saved you 5 minutes, please give us a star on GitHub: ${chalk.underline('https://github.com/paudang/nodejs-quickstart-structure')}`));
+            console.log(chalk.magenta('\n' + '★'.repeat(50)));
+            console.log(chalk.white.bold('  Enjoying the Node.js Quickstart Generator?'));
+            console.log(chalk.white(`  If this tool saved you 4+ hours of architecture setup,`));
+            console.log(chalk.white(`  please help us grow by giving us a ⭐ on GitHub!`));
+            console.log(chalk.white(`\n  👉 ${chalk.underline.bold('https://github.com/paudang/nodejs-quickstart-structure')}`));
+            console.log(chalk.magenta('★'.repeat(50) + '\n'));
 
         } catch (error) {
             if (error.name === 'ExitPromptError') {

package/lib/generator.js

@@ -1,139 +1,139 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { setupProjectDirectory, copyBaseStructure, copyCommonFiles } from './modules/project-setup.js';
-import { renderPackageJson, renderDockerCompose, renderReadme, renderDockerfile, renderProfessionalConfig, setupCiCd, renderTestSample, renderEnvExample, renderPm2Config, renderAiNativeFiles } from './modules/config-files.js';
-import { renderIndexFile, renderEnvConfig, renderErrorMiddleware, renderDynamicComponents, renderSwaggerConfig, setupViews as setupSrcViews, processAllTests } from './modules/app-setup.js';
-import { setupDatabase } from './modules/database-setup.js';
-import { setupKafka, setupViews } from './modules/kafka-setup.js';
-import { setupCaching } from './modules/caching-setup.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export const generateProject = async (config) => {
-    // 0. Normalize configuration with defaults
-    config = {
-        viewEngine: 'None',
-        caching: 'None',
-        dbName: 'demo',
-        ciProvider: 'GitHub Actions',
-        communication: 'REST APIs',
-        database: 'None',
-        includeSecurity: false,
-        ...config
-    };
-
-    const { projectName, architecture, language } = config;
-    const targetDir = path.resolve(process.cwd(), projectName);
-    const templatesDir = path.join(__dirname, '../templates');
-
-    // 1. Create project directory
-    await setupProjectDirectory(targetDir, projectName);
-
-    // 2. Select & Copy Base Structure
-    const { templatePath } = await copyBaseStructure(templatesDir, targetDir, architecture, language);
-
-    // 3. Render package.json
-    await renderPackageJson(templatesDir, targetDir, config);
-
-    // 4. Render docker-compose.yml
-    await renderDockerCompose(templatesDir, targetDir, config);
-
-    // 5. Render README.md
-    await renderReadme(templatesDir, targetDir, config);
-
-    // 6. Render index file (ts/js)
-    await renderIndexFile(templatePath, targetDir, config);
-
-    // 6a. Render Environment Configuration
-    await renderEnvConfig(templatePath, targetDir, config);
-
-    // 6a. Render error middleware
-    await renderErrorMiddleware(templatePath, targetDir, config);
-
-    // 7. Render Dynamic Components (Controllers/Repos/Server)
-    await renderDynamicComponents(templatePath, targetDir, config);
-
-    // 8. Kafka Setup
-    await setupKafka(templatesDir, targetDir, config);
-
-    // 9. Common Files (.gitignore, Dockerfile, tsconfig)
-    await copyCommonFiles(templatesDir, targetDir, language);
-    await renderDockerfile(templatesDir, targetDir, config);
-
-    // 10. Database Setup (Migrations, Config, Models)
-    // Note: logic for detailed view copying is also handled nicely if we ensure setupDatabase checks correctly,
-    // or we can move strict view logic to setupViews. 
-    // In strict refactor, database-setup handles the content that was in the DB block.
-    await setupDatabase(templatesDir, targetDir, config);
-
-    // 10a. Caching Setup
-    await setupCaching(templatesDir, targetDir, config);
-
-    // 11. View Engine Public Assets (MVC)
-    await setupViews(templatesDir, targetDir, config);
-    // Copy src/views (MVC)
-    await setupSrcViews(templatesDir, targetDir, config);
-
-    // 12. Swagger Config
-    await renderSwaggerConfig(templatesDir, targetDir, config);
-
-    // 13. Professional Config & Tests
-    await renderProfessionalConfig(templatesDir, targetDir, config);
-    await renderTestSample(templatesDir, targetDir, config);
-
-    // 13.5 AI-Native Scaffolding
-    await renderAiNativeFiles(templatesDir, targetDir, config);
-
-    // 14. CI/CD
-    await setupCiCd(templatesDir, targetDir, config);
-
-    // 15. Env Example
-    await renderEnvExample(templatesDir, targetDir, config);
-
-    // 16. PM2 Configuration
-    await renderPm2Config(templatesDir, targetDir, config);
-
-    // 17. Process All Tests
-    await processAllTests(targetDir, config);
-
-    console.log(`
-      ====================================================
-             Node.js Project Created Successfully!
-      ====================================================
-
-      Project: ${projectName}
-      Architecture: ${architecture}
-      Language: ${language}
-      Database: ${config.database}
-      Communication: ${config.communication}${config.caching && config.caching === 'Redis' ? `\n      Caching: ${config.caching}` : ''}
-
-      ----------------------------------------------------
-      ✨  High-Quality Standards Applied:
-      ----------------------------------------------------
-      ✅  Linting & Formatting: Eslint + Prettier configured
-      ✅  Git Hooks: Husky + Lint-Staged ready
-      ✅  Security: Helmet, CORS, Rate-Limiting added${config.includeSecurity ? '\n      ✅  Enterprise Security: Snyk (SCA) & SonarCloud (SAST) integration' : ''}
-      ✅  Testing: Jest setup for Unit/Integration tests
-      ✅  Docker: Production-ready multi-stage build
-      ${config.ciProvider !== 'None' ? `✅  CI/CD: ${config.ciProvider} Workflow ready` : '❌  CI/CD: Skipped (User preferred)'}
-
-      ----------------------------------------------------
-      🚀  Project is AI-Ready!
-      ----------------------------------------------------
-      🤖  We detected you are using AI tools. 
-      📍  Use Cursor? We've configured '.cursorrules' for you.
-      📍  Use ChatGPT/Gemini? Check the 'prompts/' folder for Agent Skills.
-
-      ----------------------------------------------------
-      👉  Next Steps:
-      ----------------------------------------------------
-      1. cd ${projectName}
-      2. git init
-      3. npm install
-      4. npm run prepare      (To setup Husky hooks)
-      5. docker-compose up -d${config.database !== 'None' ? ' db' : ''}${config.caching === 'Redis' ? ' redis' : ''}${config.communication === 'Kafka' ? ' kafka' : ''} (To start DB/Infrastructure)
-      6. npm run dev          (To start development server)
-      7. npm test             (To run tests)
-    `);
-};
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { setupProjectDirectory, copyBaseStructure, copyCommonFiles } from './modules/project-setup.js';
+import { renderPackageJson, renderDockerCompose, renderReadme, renderDockerfile, renderProfessionalConfig, setupCiCd, renderTestSample, renderEnvExample, renderPm2Config, renderAiNativeFiles } from './modules/config-files.js';
+import { renderIndexFile, renderEnvConfig, renderErrorMiddleware, renderDynamicComponents, renderSwaggerConfig, setupViews as setupSrcViews, processAllTests } from './modules/app-setup.js';
+import { setupDatabase } from './modules/database-setup.js';
+import { setupKafka, setupViews } from './modules/kafka-setup.js';
+import { setupCaching } from './modules/caching-setup.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export const generateProject = async (config) => {
+    // 0. Normalize configuration with defaults
+    config = {
+        viewEngine: 'None',
+        caching: 'None',
+        dbName: 'demo',
+        ciProvider: 'GitHub Actions',
+        communication: 'REST APIs',
+        database: 'None',
+        includeSecurity: false,
+        ...config
+    };
+
+    const { projectName, architecture, language } = config;
+    const targetDir = path.resolve(process.cwd(), projectName);
+    const templatesDir = path.join(__dirname, '../templates');
+
+    // 1. Create project directory
+    await setupProjectDirectory(targetDir, projectName);
+
+    // 2. Select & Copy Base Structure
+    const { templatePath } = await copyBaseStructure(templatesDir, targetDir, architecture, language);
+
+    // 3. Render package.json
+    await renderPackageJson(templatesDir, targetDir, config);
+
+    // 4. Render docker-compose.yml
+    await renderDockerCompose(templatesDir, targetDir, config);
+
+    // 5. Render README.md
+    await renderReadme(templatesDir, targetDir, config);
+
+    // 6. Render index file (ts/js)
+    await renderIndexFile(templatePath, targetDir, config);
+
+    // 6a. Render Environment Configuration
+    await renderEnvConfig(templatePath, targetDir, config);
+
+    // 6a. Render error middleware
+    await renderErrorMiddleware(templatePath, targetDir, config);
+
+    // 7. Render Dynamic Components (Controllers/Repos/Server)
+    await renderDynamicComponents(templatePath, targetDir, config);
+
+    // 8. Kafka Setup
+    await setupKafka(templatesDir, targetDir, config);
+
+    // 9. Common Files (.gitignore, Dockerfile, tsconfig)
+    await copyCommonFiles(templatesDir, targetDir, language);
+    await renderDockerfile(templatesDir, targetDir, config);
+
+    // 10. Database Setup (Migrations, Config, Models)
+    // Note: logic for detailed view copying is also handled nicely if we ensure setupDatabase checks correctly,
+    // or we can move strict view logic to setupViews. 
+    // In strict refactor, database-setup handles the content that was in the DB block.
+    await setupDatabase(templatesDir, targetDir, config);
+
+    // 10a. Caching Setup
+    await setupCaching(templatesDir, targetDir, config);
+
+    // 11. View Engine Public Assets (MVC)
+    await setupViews(templatesDir, targetDir, config);
+    // Copy src/views (MVC)
+    await setupSrcViews(templatesDir, targetDir, config);
+
+    // 12. Swagger Config
+    await renderSwaggerConfig(templatesDir, targetDir, config);
+
+    // 13. Professional Config & Tests
+    await renderProfessionalConfig(templatesDir, targetDir, config);
+    await renderTestSample(templatesDir, targetDir, config);
+
+    // 13.5 AI-Native Scaffolding
+    await renderAiNativeFiles(templatesDir, targetDir, config);
+
+    // 14. CI/CD
+    await setupCiCd(templatesDir, targetDir, config);
+
+    // 15. Env Example
+    await renderEnvExample(templatesDir, targetDir, config);
+
+    // 16. PM2 Configuration
+    await renderPm2Config(templatesDir, targetDir, config);
+
+    // 17. Process All Tests
+    await processAllTests(targetDir, config);
+
+    console.log(`
+      ====================================================
+             Node.js Project Created Successfully!
+      ====================================================
+
+      Project: ${projectName}
+      Architecture: ${architecture}
+      Language: ${language}
+      Database: ${config.database}
+      Communication: ${config.communication}${config.caching && config.caching === 'Redis' ? `\n      Caching: ${config.caching}` : ''}
+
+      ----------------------------------------------------
+      ✨  High-Quality Standards Applied:
+      ----------------------------------------------------
+      ✅  Linting & Formatting: Eslint + Prettier configured
+      ✅  Git Hooks: Husky + Lint-Staged ready
+      ✅  Security: Helmet, CORS, Rate-Limiting added${config.includeSecurity ? '\n      ✅  Enterprise Security: Snyk (SCA) & SonarCloud (SAST) integration' : ''}
+      ✅  Testing: Jest setup for Unit/Integration tests
+      ✅  Docker: Production-ready multi-stage build
+      ${config.ciProvider !== 'None' ? `✅  CI/CD: ${config.ciProvider} Workflow ready` : '❌  CI/CD: Skipped (User preferred)'}
+
+      ----------------------------------------------------
+      🚀  Project is AI-Ready!
+      ----------------------------------------------------
+      🤖  We detected you are using AI tools. 
+      📍  Use Cursor? We've configured '.cursorrules' for you.
+      📍  Use ChatGPT/Gemini? Check the 'prompts/' folder for Agent Skills.
+
+      ----------------------------------------------------
+      👉  Next Steps:
+      ----------------------------------------------------
+      1. cd ${projectName}
+      2. git init
+      3. npm install
+      4. npm run prepare      (To setup Husky hooks)
+      5. docker-compose up -d${config.database !== 'None' ? ' db' : ''}${config.caching === 'Redis' ? ' redis' : ''}${config.communication === 'Kafka' ? ' kafka' : ''} (To start DB/Infrastructure)
+      6. npm run dev          (To start development server)
+      7. npm test             (To run tests)
+    `);
+};