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
• 1.41M 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.

Run the generator using your preferred package manager (no global installation required):

# npm
npx nodejs-quickstart-structure@latest init

# pnpm
pnpm dlx nodejs-quickstart-structure@latest init

# yarn
yarn dlx nodejs-quickstart-structure@latest init

Or install globally:

# npm
npm install -g nodejs-quickstart-structure

# pnpm
pnpm add -g nodejs-quickstart-structure

# yarn
yarn global add nodejs-quickstart-structure

# Then run:
nodejs-quickstart init

What's New in v2.8 (The Generator Multiverse Release)

The v2.8.0 release introduces a revolutionary Gamification layer to the scaffolding experience:

• The Architecture Skill Tree: An RPG-style interactive tech tree designed to help developers systematically build an enterprise application from the ground up.
• Backend Factorio Builder: A drag-and-drop puzzle mode where users connect nodes to construct production-ready microservice pipelines.
• Dynamic 100% Feature Parity: The interactive games map 1:1 with the CLI, seamlessly generating complex setups like Multi-Cloud Terraform, CI/CD, Authentication, and ELK Stack.
• Zero-Vulnerability Baseline: Strictly enforced package overrides to guarantee pristine snyk test and npm audit reports out-of-the-box.

What's New in v2.7 (The Background Jobs Release)

The v2.7.0 release brings robust asynchronous processing and architectural purity to your microservices:

• Enterprise Background Jobs: Fully integrated BullMQ with Redis for high-performance, asynchronous job processing, complete with Bull-Board UI for real-time monitoring and queue management.
• Package Manager Agnosticism: A completely refactored generation engine that provides a flawless, zero-friction experience across npm, yarn, and pnpm without tying your package.json to any specific tool.
• VitePress Docs Sync: Tabbed Markdown synchronization across the entire documentation site, ensuring your reading experience perfectly matches your chosen package manager.

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 .cursorrules and Agent Skill prompts.

Professional Standards

We don't just generate boilerplate; we generate production-ready foundations. Every project includes:

• Code Quality: Pre-configured Eslint and Prettier.
• 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 Jest and Supertest with >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.

1.41M+ Project Combinations

The CLI provides massive flexibility to fit your exact needs. Instead of a rigid boilerplate, it acts like architectural Lego blocks.

• 1,419,264+ Verified Scenarios: Whether you choose MongoDB + GraphQL + Redis or PostgreSQL + REST + No Cache, the generated code compiles, runs, and passes tests out-of-the-box.
• Mix & Match: Seamlessly combine your preferred Database, Caching, Auth, and Communication patterns.
• Enterprise-Ready: Every combination guarantees compatibility with our 80% Test Coverage policy, Docker builds, and CI/CD pipelines.

Curious about the math? Check out our Mathematical Verification Matrix for the full calculation.

Configuration Options

The CLI will guide you through:

1. Project Name
2. Language: JavaScript | TypeScript
3. Architecture: MVC | Clean Architecture
4. View Engine: (MVC only) None | EJS | Pug
5. Communication: REST | GraphQL | Kafka
6. Database: MySQL | PostgreSQL | MongoDB
7. Caching: None | Redis | Memory Cache
8. Auth: None | JWT | OAuth2 (Google/GitHub) + JWT
9. CI/CD: GitHub Actions | Jenkins | GitLab CI | CircleCI | Bitbucket Pipelines
10. Security: (Optional) Snyk & SonarCloud Hardening
11. Advanced Options: Yes | No
    • Resilience: (Optional) Timeout | Retry | Circuit Breaker
    • Cloud Infrastructure: (Optional IaC) Terraform for AWS | GCP | Azure (None | Standard | Production)
    • Observability: (Optional) Centralized Logging via ELK Stack
    • Background Jobs: (Optional) BullMQ + Bull-Board Task Queues (Requires Redis)

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 template

Documentation

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

If this tool saved you hours of work, please give us a Star!

License

ISC