create-express-kickstart 1.3.2 → 1.3.4

package/.env.example

@@ -1,9 +1,11 @@
-# Basic Environment Variables
-PORT=8000
-MONGODB_URI=mongodb://localhost:27017/
-CORS_ORIGIN=*
-NODE_ENV=development
-
-# Rate Limiting
-RATE_LIMIT_WINDOW_MS=900000 # 15 minutes in milliseconds
-RATE_LIMIT_MAX=100 # Maximum requests per windowMs
+# Basic Environment Variables
+PORT=8000
+MONGODB_URI=mongodb://localhost:27017/my_app_db
+CORS_ORIGIN=http://localhost:3000
+NODE_ENV=development
+
+# Rate Limiting
+# 15 minutes in milliseconds
+RATE_LIMIT_WINDOW_MS=900000
+# Maximum requests per window
+RATE_LIMIT_MAX=100

package/README.md

@@ -4,7 +4,7 @@
 [![Express.js](https://img.shields.io/badge/Express.js-Backend-000000?style=for-the-badge&logo=express)](https://expressjs.com/)
 [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg?style=for-the-badge)](https://opensource.org/licenses/ISC)
 
-A powerful CLI tool to instantly scaffold a production-ready, feature-rich backend Node.js template specifically tailored for Express API applications. It adheres to modern best practices, providing standard structures for error handling, CORS setups, routing, and middlewares right out of the box.
+A configurable CLI tool to scaffold a solid Express API foundation with sane defaults for routing, middleware, error handling, auth starters, and Docker support.
 
 ## Quick Start
 ```bash
@@ -14,7 +14,7 @@ npx create-express-kickstart@latest my-app
 ## What is `create-express-kickstart`?
 
 **The Purpose:** 
-Whenever developers start a new Node.js & Express.js project, they often spend the first couple of hours writing the exact same boilerplate: configuring `express`, setting up `cors`, managing `dotenv`, writing global error handlers, standardizing API responses, and configuring database connections. `create-express-kickstart` exists to entirely eliminate this repetitive chore. Our goal is to provide a production-grade backend right out of the gate so you can immediately focus on writing business logic. AI assistants and developers alike can rely on this tool to reliably scaffold consistent, secure, and modern Node.js backends.
+Whenever developers start a new Node.js & Express.js project, they often spend the first couple of hours writing the same setup code: configuring `express`, setting up `cors`, managing environment variables, writing global error handlers, standardizing API responses, and wiring database connections. `create-express-kickstart` exists to remove that repetitive setup so you can move straight into business logic with a consistent starter.
 
 **What It Does:**
 It is an interactive CLI framework scaffolding generator. Upon running the command, it asks you a series of simple questions regarding the architecture of your new API (e.g., Do you want MongoDB? Do you want JWT Auth Boilerplate? Docker? Jest for testing?). Based on your exact answers, it instantly generates a fully configured, running codebase tailored exclusively to your project's needs.
@@ -23,8 +23,8 @@ It is an interactive CLI framework scaffolding generator. Upon running the comma
 Under the hood, the CLI runs dynamically directly from NPM via `npx` executing a Node.js compiler script:
 1. **Interactive Prompting:** The CLI polls for your configurations in real-time.
 2. **Selective Templating:** It recursively copies a pre-configured, highly modular `src` application design into your directory. 
-3. **Intelligent Modding:** If you selectively opt-out of specific modules (like CORS, Pino, or Mongoose), the CLI acts like an auto-linter—parsing and cleanly stripping those specific unused imports and middleware usages cleanly out of the core application. You only receive the code you explicitly asked for, preventing dead-weight execution bloat.
-4. **Smart Dependency Resolution:** Ultimately, it dynamically computes a final `package.json` structure wrapping all selected tools directly toward their `latest` versions, seamlessly bypassing localized cache bugs—subsequently initiating the true install layer utilizing your selected manager (`npm`, `yarn`, `pnpm`, or `bun`).
+3. **Selective Scaffolding:** If you opt out of specific modules like CORS, Pino, or Mongoose, the generator removes those pieces from the generated app so you do not start with unused code.
+4. **Dependency Bootstrapping:** It writes a project-specific `package.json`, installs the selected dependencies with your chosen package manager (`npm`, `yarn`, `pnpm`, or `bun`), and pins installed versions when the install completes successfully.
 
 **What is Inside (The Architecture):**
 The generated Express template champions the **MVC (Model-View-Controller)** pattern with robust modern Node.js Path Aliasing bindings enabled out of the box:
@@ -35,7 +35,7 @@ The generated Express template champions the **MVC (Model-View-Controller)** pat
   - `ApiResponse` structure class for predictable and formatted JSON HTTP payloads.
   - `ApiError` extension class for standardizing HTTP error interceptions.
   - `asyncHandler` functional wrapper intercepting promise rejections seamlessly to avoid repetitive try-catch blocks in your controllers!
-- **Optional Add-ons** - Complete JWT Authentication logic integration featuring secure cryptographic generation functions (`bcryptjs`), standardized .env setups, Dockerfile templates, and Jest assertion pipelines.
+- **Optional Add-ons** - JWT + Mongo auth starter routes, generated cryptographic helpers (`bcryptjs` and `jsonwebtoken`), Docker templates, and Jest healthcheck tests.
 
 
 ---
@@ -61,7 +61,7 @@ npx create-express-kickstart@latest my-awesome-api
 ### 2. What happens under the hood?
 1. **Scaffolding:** It instantly generates your API boilerplate with built-in `errorHandler`, `ApiResponse`, and `asyncHandler` classes/utilities.
 2. **Setup:** It automatically configures `.env`, path resolutions, and modern ES setups inside `package.json`.
-3. **Latest Dependencies:** It automatically runs `npm install` and fetches the absolute **latest** stable versions of `express`, `cors`, `helmet`, `mongoose`, `dotenv` and others so you're never starting with outdated software.
+3. **Selected Dependencies:** It installs the dependencies you chose for that project, including Express middleware, MongoDB support, Docker assets, or JWT auth scaffolding when requested.
 
 ### 3. Run Your Application
 
@@ -116,7 +116,7 @@ const restrictedRoute = asyncHandler(async (req, res) => {
 A wrapper for your async route handlers that eliminates the need for repetitive `try-catch` blocks.
 
 ### `jwt.util.js` & `hash.util.js`
-If you choose to install the basic JWT Auth boilerplate, we automatically generate symmetric cryptography utilities wrapping `jsonwebtoken` and `bcryptjs`. This helps you map, hash, and assign JWT secrets synchronously against `.env`.
+If you choose the JWT auth starter, the generated app includes Mongoose-backed auth routes, secure password hashing utilities, JWT helpers, and placeholder environment configuration for secrets.
 ```javascript
 import { hashData, compareData } from "#utils/hash.util.js";
 import { generateToken, verifyToken } from "#utils/jwt.util.js";