nodejs-quickstart-structure 1.19.1 β†’ 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +45 -10
  3. package/bin/index.js +7 -1
  4. package/lib/prompts.js +1 -1
  5. package/package.json +3 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
2
2
 
3
+ ## [2.0.0] - 2026-04-02
4
+
5
+ ### Added
6
+ - **Next-Gen Web UI Configurator (v2.0.0)**: Launched a fully interactive, browser-based visual generator featuring real-time architecture visualization.
7
+ - **1,680+ Combinations Automated**: Mapped out the entire 1:1 file logic for the permutations mathematically validated across Clean Architecture, MVC, WebSockets, Kafka, Docker, databases, etc.
8
+ - **AI-Native Discovery Protocol**: Integrated `llms.txt` standards across the repository and documentation to provide explicit architectural context for AI coding assistants (Claude, GPT-4, Cursor).
9
+ - **Growth-Driven Developer Experience**: Orchestrated a high-conversion "Star on GitHub" funnel within the CLI and Web Configurator to bridge the gap between downloads and community support.
10
+ - **Zero-Impact CLI Parity**: Advanced flag generation system in the Web UI allows 1-click clipboard exporting to seamlessly execute the backend `init` command without hanging on any interactive prompts.
11
+ - **Exhaustive 1,680 Validation Script**: Introduced automation logic to assert successful output generation spanning every configuration option matrix.
12
+ - **Strategic Social Proof**: Re-engineered the project's documentation and landing page to emphasize real-world adoption (4,000+ downloads) and architectural credibility.
13
+
3
14
  ## [1.19.1] - 2026-04-01
4
15
 
5
16
  ### Fixed
package/README.md CHANGED
@@ -5,12 +5,36 @@
5
5
  [![npm monthly downloads](https://img.shields.io/npm/dm/nodejs-quickstart-structure.svg?style=flat-square)](https://www.npmjs.com/package/nodejs-quickstart-structure)
6
6
  [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg?style=flat-square)](https://opensource.org/licenses/ISC)
7
7
 
8
- 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.
8
+ ### πŸ“ˆ Real-world Adoption
9
+ | **Metric** | **Insight** |
10
+ | :--- | :--- |
11
+ | πŸ”₯ **4,000+** | Downloads on npm |
12
+ | πŸš€ **1,200+** | Recent GitHub Clones |
13
+ | 🌍 **Trusted by** | Devs from **Google**, **Viblo**, and global tech teams |
14
+
15
+ ---
16
+
17
+ 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.
18
+
19
+ 🎯 **[Try the Next-Gen Web UI Configurator!](https://paudang.github.io/nodejs-quickstart-structure/)**
20
+ *Generate your exact architecture in the browser with real-time folder simulation.*
9
21
 
10
22
  ![Demo](docs/demo.gif)
11
23
 
12
24
  ---
13
25
 
26
+ ## πŸ†• What's New in v2.0.0
27
+
28
+ The v2.0.0 release is a major leap forward, turning the generator into a **Community Standard** for Node.js development:
29
+
30
+ - **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/).
31
+ - **🦾 AI-Native Foundation**: Built-in `.cursorrules` and Agent skills optimized for **Cursor** & AI coding assistants.
32
+ - **πŸ—οΈ Enterprise Clean Architecture**: High-fidelity structure for professional Microservices (TS/JS).
33
+ - **πŸ›‘οΈ Hardened Security**: Integrated Snyk & SonarCloud logic in the core templates.
34
+ - **⚑ Zero-Prompt Workflow**: Generate projects with a single CLI commandβ€”no more answering prompts manually.
35
+
36
+ ---
37
+
14
38
  ## πŸ“Œ Table of Contents
15
39
 
16
40
  - [πŸš€ Quick Start](#-quick-start)
@@ -53,7 +77,6 @@ nodejs-quickstart init
53
77
  - **Communication Patterns**: Supports **REST**, **GraphQL** (Apollo), and **Kafka** (Event-driven).
54
78
  - **Multi-layer Caching**: Integrated **Redis** or built-in **Memory Cache**.
55
79
  - **AI-Native Optimized**: specifically designed for **Cursor** and AI agents, including built-in `.cursorrules` and Agent Skill prompts. πŸš€
56
- - **Next Gen Web UI**: (Coming Soon) A modern, browser-based project selector featuring real-time virtualization β€” set for release in v2.0.0!
57
80
 
58
81
  ---
59
82
 
@@ -100,8 +123,7 @@ The CLI will guide you through:
100
123
  ---
101
124
 
102
125
  ## πŸ—οΈ Generated Project Structure
103
-
104
- A typical generated project (TypeScript + Clean Architecture) looks like this:
126
+ Depending on your choices, the structure adapts. Here is a **TypeScript + Clean Architecture** preview:
105
127
 
106
128
  ```text
107
129
  .
@@ -111,12 +133,13 @@ A typical generated project (TypeScript + Clean Architecture) looks like this:
111
133
  β”‚ β”œβ”€β”€ infrastructure/ # DB, External services, Repositories
112
134
  β”‚ β”œβ”€β”€ interfaces/ # Controllers, Routes, GraphQL, Kafka
113
135
  β”‚ β”œβ”€β”€ errors/ # Custom Error Classes
114
- β”‚ └── index.ts # Entry point
136
+ β”‚ β”œβ”€β”€ config/ # Environment & Global settings
137
+ β”‚ └── index.ts # Server entry point
115
138
  β”œβ”€β”€ flyway/sql/ # SQL migrations (if applicable)
116
139
  β”œβ”€β”€ docker-compose.yml # Infrastructure services
117
140
  β”œβ”€β”€ package.json # Scripts and dependencies
118
- β”œβ”€β”€ tsconfig.json # TypeScript config
119
- └── .cursorrules # AI assistance rules
141
+ β”œβ”€β”€ .cursorrules # AI assistance rules (The "AI Brain")
142
+ └── .env.example # Environment template
120
143
  ```
121
144
 
122
145
  ---
@@ -130,9 +153,9 @@ For full guides, architecture deep-dives, and feature references, visit our **[O
130
153
  ## ❀️ Support & πŸ—ΊοΈ Roadmap
131
154
 
132
155
  ### Support the Project
133
- We just hit **3,000+ downloads**! If this tool helped you, please:
134
- - Give us a ⭐ on [GitHub](https://github.com/paudang/nodejs-quickstart-structure).
135
- - Read our [Medium Article](https://medium.com/@paudang/nodejs-quickstart-generator-93c276d60e0b) for tutorials.
156
+ If this tool helped you build your project faster, please support us:
157
+ - Give us a ⭐ on [GitHub](https://github.com/paudang/nodejs-quickstart-structure) to help us reach our next milestone!
158
+ - Read our [Medium Series](https://medium.com/@paudang/nodejs-quickstart-generator-93c276d60e0b) for architecture deep-dives.
136
159
 
137
160
  ### Roadmap
138
161
  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:
140
163
 
141
164
  ---
142
165
 
166
+ ## ⭐ Why Star us?
167
+
168
+ 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:
169
+
170
+ 1. **Attract Contributors**: More stars attract professional maintainers to keep this project secure and up-to-date.
171
+ 2. **AI Model Awareness**: Popular repositories are weighted higher by AI coding assistants (Cursor, Copilot, etc.), making the generated code even better.
172
+ 3. **Open Source Sustainability**: It motivates us to keep building and shipping "Enterprise-Grade" features for free.
173
+
174
+ If this tool saved you hours of work, **[please give us a Star!](https://github.com/paudang/nodejs-quickstart-structure)** πŸš€
175
+
176
+ ---
177
+
143
178
  ## License
144
179
 
145
180
  ISC
package/bin/index.js CHANGED
@@ -31,6 +31,7 @@ program
31
31
  .option('-c, --communication <communication>', 'Communication (REST APIs, GraphQL, Kafka)')
32
32
  .option('--ci-provider <provider>', 'CI/CD Provider (None, GitHub Actions, Jenkins, GitLab CI)')
33
33
  .option('--include-security', 'Include Enterprise Security Hardening')
34
+ .option('--no-include-security', 'Exclude Enterprise Security Hardening')
34
35
  .option('--caching <type>', 'Caching Layer (None/Redis)')
35
36
  .action(async (options) => {
36
37
  // Fix for Commander camelCase conversion
@@ -74,7 +75,12 @@ program
74
75
 
75
76
  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`));
76
77
 
77
- 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')}`));
78
+ console.log(chalk.magenta('\n' + 'β˜…'.repeat(50)));
79
+ console.log(chalk.white.bold(' Enjoying the Node.js Quickstart Generator?'));
80
+ console.log(chalk.white(` If this tool saved you 4+ hours of architecture setup,`));
81
+ console.log(chalk.white(` please help us grow by giving us a ⭐ on GitHub!`));
82
+ console.log(chalk.white(`\n πŸ‘‰ ${chalk.underline.bold('https://github.com/paudang/nodejs-quickstart-structure')}`));
83
+ console.log(chalk.magenta('β˜…'.repeat(50) + '\n'));
78
84
 
79
85
  } catch (error) {
80
86
  if (error.name === 'ExitPromptError') {
package/lib/prompts.js CHANGED
@@ -84,7 +84,7 @@ export const getProjectDetails = async (options = {}) => {
84
84
  message: 'Include Enterprise Security Hardening (Big Tech Standard: Snyk, SonarQube)?',
85
85
  choices: ['No', 'Yes'],
86
86
  default: "No",
87
- when: (answers) => !options.includeSecurity && (options.ciProvider || answers.ciProvider) !== 'None'
87
+ when: (answers) => options.includeSecurity === undefined && (options.ciProvider || answers.ciProvider) !== 'None'
88
88
  }
89
89
  ];
90
90
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nodejs-quickstart-structure",
3
- "version": "1.19.1",
3
+ "version": "2.0.0",
4
4
  "type": "module",
5
5
  "description": "The ultimate nodejs quickstart structure CLI to scaffold Node.js microservices with MVC or Clean Architecture",
6
6
  "main": "bin/index.js",
@@ -12,6 +12,7 @@
12
12
  "test:e2e": "npm run test:e2e:windows",
13
13
  "test:e2e:windows": "node scripts/validate-windows.js",
14
14
  "test:e2e:linux": "node scripts/validate-linux.js",
15
+ "test:validate-command": "node scripts/validate-command.js",
15
16
  "test:verify:mongo": "node scripts/verify-migration.js",
16
17
  "docs:dev": "vitepress dev docs",
17
18
  "docs:build": "vitepress build docs",
@@ -75,4 +76,4 @@
75
76
  "README.md",
76
77
  "CHANGELOG.md"
77
78
  ]
78
- }
79
+ }