create-express-kickstart 1.2.5 → 1.2.7
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.
- package/README.md +34 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,38 @@
|
|
|
6
6
|
|
|
7
7
|
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.
|
|
8
8
|
|
|
9
|
+
## Quick Start
|
|
10
|
+
```bash
|
|
11
|
+
npx create express-kickstart@latest my-app
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## What is `create-express-kickstart`?
|
|
15
|
+
|
|
16
|
+
**The Purpose:**
|
|
17
|
+
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.
|
|
18
|
+
|
|
19
|
+
**What It Does:**
|
|
20
|
+
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.
|
|
21
|
+
|
|
22
|
+
**How It Works:**
|
|
23
|
+
Under the hood, the CLI runs dynamically directly from NPM via `npx` executing a Node.js compiler script:
|
|
24
|
+
1. **Interactive Prompting:** The CLI polls for your configurations in real-time.
|
|
25
|
+
2. **Selective Templating:** It recursively copies a pre-configured, highly modular `src` application design into your directory.
|
|
26
|
+
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.
|
|
27
|
+
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`).
|
|
28
|
+
|
|
29
|
+
**What is Inside (The Architecture):**
|
|
30
|
+
The generated Express template champions the **MVC (Model-View-Controller)** pattern with robust modern Node.js Path Aliasing bindings enabled out of the box:
|
|
31
|
+
- **/src/controllers** - Functional logic handlers.
|
|
32
|
+
- **/src/routes** - Isolated Express routers mapping precise endpoints to controllers.
|
|
33
|
+
- **/src/middlewares** - Pre-configured intercepts including a robust Global errorHandler.
|
|
34
|
+
- **/src/utils** - Core toolkit items mapped globally across the codebase. Highlights include:
|
|
35
|
+
- `ApiResponse` structure class for predictable and formatted JSON HTTP payloads.
|
|
36
|
+
- `ApiError` extension class for standardizing HTTP error interceptions.
|
|
37
|
+
- `asyncHandler` functional wrapper intercepting promise rejections seamlessly to avoid repetitive try-catch blocks in your controllers!
|
|
38
|
+
- **Optional Add-ons** - Complete JWT Authentication logic integration featuring secure cryptographic generation functions (`bcryptjs`), standardized .env setups, Dockerfile templates, and Jest assertion pipelines.
|
|
39
|
+
|
|
40
|
+
|
|
9
41
|
---
|
|
10
42
|
|
|
11
43
|
## Getting Started
|
|
@@ -106,3 +138,5 @@ Feel free to open an issue or submit a pull request on our GitHub Repository!
|
|
|
106
138
|
|
|
107
139
|
**GitHub Repository:** [https://github.com/aasifashraf/create-express-kickstart](https://github.com/aasifashraf/create-express-kickstart)
|
|
108
140
|
|
|
141
|
+
**NPM Package:** [https://www.npmjs.com/package/create-express-kickstart](https://www.npmjs.com/package/create-express-kickstart)
|
|
142
|
+
|