nodejs-quickstart-structure
v2.3.0
Published
The ultimate nodejs quickstart structure CLI to scaffold Node.js microservices with MVC or Clean Architecture
Maintainers
Readme
Node.js Quickstart Generator
A powerful ecosystem 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.
Table of Contents
- Quick Start
- What's New
- Key Features
- Professional Standards
- 23,760+ Project Combinations
- Configuration Options
- Generated Project Structure
- Documentation
- Support & Roadmap
Choose Your Journey
| Path A: Next-Gen Web UI (Recommended) | Path B: Interactive CLI |
| :--- | :--- |
| | |
| Try Visual Configurator → | See CLI Commands ↓ |
| Visual Preview: Real-time folder simulation. | Fast & Direct: Quickly scaffold in terminal. |
| Zero-Prompt: Paste a tailored command. | AI-Ready: Generates .cursorrules. |
Path B: Interactive CLI
Scaffold your project directly from your terminal in seconds.
npx nodejs-quickstart-structure@latest initOr install globally:
npm install -g nodejs-quickstart-structure
# Then run:
nodejs-quickstart initWhat's New in v2.3 (The Infrastructure & Terraform Release)
The v2.3.0 release brings professional-grade Infrastructure as Code (IaC) to your generated projects:
- Terraform Infrastructure Integration (IaC): Support for modular, production-ready AWS Terraform scaffolding with Multi-AZ VPC network isolation, WAF, application load balancers, database layers, and ElastiCache.
- Massive Matrix Expansion: Now supporting 23,760+ unique project scenarios, mathematically validated for template consistency.
Key Features
- Interactive CLI: Smooth, guided configuration process.
- Multiple Architectures: Supports both MVC and Clean Architecture.
- Modern Languages: Choice of JavaScript or TypeScript.
- Database Ready: Pre-configured for MySQL, PostgreSQL, or MongoDB.
- Communication Patterns: Supports REST, GraphQL (Apollo), and Kafka (Event-driven).
- Multi-layer Caching: Integrated Redis or built-in Memory Cache.
- Pluggable Authentication: Built-in JWT and OAuth2 (Google/GitHub) support with Access/Refresh token rotation.
- AI-Native Optimized: specifically designed for Cursor and AI agents, including built-in
.cursorrulesand Agent Skill prompts.
Professional Standards
We don't just generate boilerplate; we generate production-ready foundations. Every project includes:
- Code Quality: Pre-configured
EslintandPrettier. - Enterprise Security: Integrated Snyk (SCA), SonarCloud (SAST),
Helmet,HPP, and Rate-Limiting. - Robust Error Handling: Centralized global error middleware with custom error classes (
ApiError,NotFoundError, etc.) — consistent across REST & GraphQL. - Testing Excellence: Integrated
JestandSupertestwith >80% Unit Test coverage out of the box. - DevOps & CI/CD: Optimized Multi-Stage Dockerfiles, health checks, infrastructure retry logic, and workflows for GitHub Actions, Jenkins, GitLab CI, CircleCI, and Bitbucket Pipelines.
- Scalable Deployment: Integrated PM2 Ecosystem config for zero-downtime reloads.
23,760+ Project Combinations
The CLI supports a massive number of configurations to fit your exact needs:
- 2,160 Core Combinations:
- MVC Architecture: 1,620 variants (Languages × View Engines × Databases × Communication Patterns × Caching × Auth × Infrastructure)
- Clean Architecture: 540 variants (Languages × Databases × Communication Patterns × Caching × Auth × Infrastructure)
- 23,760+ Total Scenarios:
- Every combination can be generated across 5 CI/CD providers.
- Optional Enterprise-Grade Security Hardening doubles the scenarios.
- Every single scenario is verified to be compatible with our 80% Coverage Threshold policy.
Configuration Options
The CLI will guide you through:
- Project Name
- Language:
JavaScript|TypeScript - Architecture:
MVC|Clean Architecture - View Engine: (MVC only)
None|EJS|Pug - Database:
MySQL|PostgreSQL|MongoDB - Communication:
REST|GraphQL|Kafka - Caching:
None|Redis|Memory Cache - Auth:
None|JWT|OAuth2 (Google/GitHub) + JWT - CI/CD:
GitHub Actions|Jenkins|GitLab CI|CircleCI|Bitbucket Pipelines - Security: (Optional) Snyk & SonarCloud Hardening
- Infrastructure: (Optional IaC)
None|Standard(Single EC2) |Production(WAF + ALB + Multi-AZ VPC)
Generated Project Structure
Depending on your choices, the structure adapts. Here is a TypeScript + Clean Architecture preview:
.
├── src/
│ ├── application/ # Use cases & Business logic
│ ├── domain/ # Entities & Repository interfaces
│ ├── infrastructure/ # DB, External services, Repositories
│ ├── interfaces/ # Controllers, Routes, GraphQL, Kafka
│ ├── errors/ # Custom Error Classes
│ ├── 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
├── .cursorrules # AI assistance rules (The "AI Brain")
└── .env.example # Environment templateDocumentation
For full guides, architecture deep-dives, and feature references, visit our Official Documentation Site.
Support & Roadmap
Support the Project
If this tool helped you build your project faster, please support us:
- Give us a ⭐ on GitHub to help us reach our next milestone!
- Read our Medium Series for architecture deep-dives.
Roadmap
Track our progress and vote for features on our public board: View our Public Roadmap on Trello
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:
- Attract Contributors: More stars attract professional maintainers to keep this project secure and up-to-date.
- AI Model Awareness: Popular repositories are weighted higher by AI coding assistants (Cursor, Copilot, etc.), making the generated code even better.
- 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!
License
ISC
