neatnode 3.0.1 → 3.0.3

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 CHANGED
@@ -1,29 +1,39 @@
1
- # NeatNode
1
+ <div align="center">
2
+ <img src="https://i.postimg.cc/9Fvw7p3q/1762540009103.png" width="120" alt="NeatNode Logo" />
3
+ <h1>NeatNode</h1>
4
+ <p><strong>Instantly scaffold production-ready Node.js backends with one command.</strong></p>
2
5
 
3
- **NeatNode** is a plug-and-play CLI that scaffolds clean, production-ready Node.js backends in seconds.
4
- It comes with pre-built templates, optional CRUD modules, and a modern developer workflow.
6
+ <img src="https://i.postimg.cc/59sw6LN6/1762540161048.png" alt="NeatNode Banner" />
7
+ </div>
5
8
 
6
9
  ---
7
10
 
8
- ## 🚀 Features
11
+ ## Overview
9
12
 
10
- * Multiple templates: **Basic API**, **REST API**, and **Socket API**
11
- * Clean MVC folder structure
12
- * Optional CRUD scaffolding (User or Todo)
13
- * Integrated logging (Winston + Morgan)
14
- * Security middleware (Helmet, Rate Limiter)
15
- * Dynamic CLI with file removal & template customization
16
- * Ready for ESM, Redis, and future TypeScript support
13
+ **NeatNode** is a plug-and-play CLI that scaffolds clean, production-ready **Node.js backends** in seconds.
14
+ It comes with pre-built templates, optional CRUD modules, and a modern developer workflow — so you can start coding instead of configuring.
17
15
 
18
16
  ---
19
17
 
20
- ## 🧭 Installation
18
+ ## Features
19
+
20
+ - Multiple templates: **Basic API**, **REST API**, and **Socket API**
21
+ - Clean MVC folder structure
22
+ - Optional CRUD scaffolding (User or Todo)
23
+ - Integrated logging (Winston + Morgan)
24
+ - Security middleware (Helmet, Rate Limiter)
25
+ - Dynamic CLI with file removal & template customization
26
+ - Ready for ESM, Redis, and future TypeScript support
27
+
28
+ ---
29
+
30
+ ## Installation
21
31
 
22
32
  ```bash
23
33
  npm install -g neatnode
24
- ```
34
+ ````
25
35
 
26
- or run directly:
36
+ or run directly with:
27
37
 
28
38
  ```bash
29
39
  npx neatnode
@@ -31,7 +41,7 @@ npx neatnode
31
41
 
32
42
  ---
33
43
 
34
- ## ⚙️ Usage
44
+ ## Usage
35
45
 
36
46
  ```bash
37
47
  npx neatnode
@@ -42,34 +52,34 @@ npx neatnode
42
52
  * Select whether to include **CRUD** examples
43
53
  * Install dependencies and start your project:
44
54
 
45
- ```bash
46
- cd my-app
47
- npm install
48
- npm run dev
49
- ```
55
+ ```bash
56
+ cd my-app
57
+ npm install
58
+ npm run dev
59
+ ```
50
60
 
51
61
  ---
52
62
 
53
- ## 📁 Templates
63
+ ## Templates
54
64
 
55
- ### **Basic API**
65
+ ### Basic API
56
66
 
57
67
  Minimal Express setup with optional Todo CRUD.
58
68
  Perfect for small projects or quick prototypes.
59
69
 
60
- ### **REST API**
70
+ ### REST API
61
71
 
62
72
  Full architecture with controllers, services, models, routes, error handling, validation, and logging.
63
73
  Ideal for scalable, production-grade APIs.
64
74
 
65
- ### **Socket API**
75
+ ### Socket API
66
76
 
67
77
  Express + Socket.io integration with logging and CORS setup.
68
78
  Best for chat apps or real-time systems.
69
79
 
70
80
  ---
71
81
 
72
- ## 🧩 Example Structure
82
+ ## Example Project Structure
73
83
 
74
84
  ```
75
85
  src/
@@ -83,25 +93,39 @@ src/
83
93
 
84
94
  ---
85
95
 
86
- ## 🛠️ Built With
96
+ ## Built With
87
97
 
88
98
  * Node.js & Express
89
- * Inquirer (CLI)
90
- * fs-extra & path (File system automation)
91
- * Morgan & Winston (Logging)
92
- * Joi (Validation)
93
- * Helmet, Rate Limiter (Security)
99
+ * Inquirer (CLI interaction)
100
+ * fs-extra & path (file system automation)
101
+ * Morgan & Winston (logging)
102
+ * Joi (validation)
103
+ * Helmet, Rate Limiter (security)
94
104
 
95
105
  ---
96
106
 
97
- ## 🧑‍💻 Author
107
+ ## Project Screenshots
98
108
 
99
- **Aakash Gupta**
100
- [GitHub](https://github.com/aakash-gupta02) · [Email](mailto:aakashgupta052004@gmail.com)
109
+ ### Frontend Website
110
+
111
+ > Official landing page for NeatNode <img src="https://i.postimg.cc/85QVd7pn/Untitled-design.png" alt="NeatNode Landing Page" />
101
112
 
102
113
  ---
103
114
 
104
- ## 🪪 License
115
+ ### Documentation Website
116
+
117
+ > Comprehensive docs built with Nextra <img src="https://i.postimg.cc/QNY0vR5r/Untitled-design-1.png" alt="NeatNode Docs" />
118
+
119
+ ---
120
+
121
+ ## Author
122
+
123
+ **Aakash Gupta**
124
+ · [GitHub](https://github.com/aakash-gupta02) · [Email](mailto:aakashgupta052004@gmail.com) ·
125
+ [Website](https://neatnode.vercel.app) · [Docs](https://neatnodee-docs.vercel.app)
126
+
127
+ ---
105
128
 
106
- MIT © Aakash Gupta
129
+ ## License
107
130
 
131
+ MIT © Aakash Gupta
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "neatnode",
3
- "version": "3.0.1",
3
+ "version": "3.0.3",
4
4
  "description": "Plug & Play Node.js backend starter templates — build REST APIs, socket servers, and more in seconds.",
5
5
  "bin": {
6
6
  "neatnode": "./bin/index.js"
@@ -32,8 +32,6 @@ export async function createProject({ projectName, templatePath, includeCrud, cr
32
32
  console.log("🗑️ Removing CRUD files...");
33
33
  removeCrud(targetPath, crudName);
34
34
  removeCrudReferences(path.join(targetPath, "src", "app.js"));
35
- } else {
36
- console.log("✅ Including CRUD functionality...");
37
35
  }
38
36
 
39
37
  console.log(`✅ Project "${projectName}" created successfully!`);
@@ -2,7 +2,7 @@ import fs from "fs";
2
2
  import path from "path";
3
3
 
4
4
  export async function copyTemplate(srcDir, destDir, replacements = {}, ) {
5
- const ignoreList = ["node_modules", ".git", ".env", "package-lock.json"];
5
+ const ignoreList = ["node_modules", ".git", ".env", "package-lock.json", ".npmignore", "logs"];
6
6
 
7
7
  if (!fs.existsSync(destDir)) {
8
8
  fs.mkdirSync(destDir, { recursive: true });