neatnode 3.0.0 → 3.0.2
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 +63 -39
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,40 +1,50 @@
|
|
|
1
|
-
|
|
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
|
-
|
|
4
|
-
|
|
6
|
+
<img src="https://i.postimg.cc/59sw6LN6/1762540161048.png" alt="NeatNode Banner" />
|
|
7
|
+
</div>
|
|
5
8
|
|
|
6
9
|
---
|
|
7
10
|
|
|
8
|
-
##
|
|
11
|
+
## Overview
|
|
9
12
|
|
|
10
|
-
|
|
11
|
-
|
|
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
|
-
##
|
|
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
|
-
npm install -g
|
|
24
|
-
|
|
33
|
+
npm install -g neatnode
|
|
34
|
+
````
|
|
25
35
|
|
|
26
|
-
or run directly:
|
|
36
|
+
or run directly with:
|
|
27
37
|
|
|
28
38
|
```bash
|
|
29
|
-
npx
|
|
39
|
+
npx neatnode
|
|
30
40
|
```
|
|
31
41
|
|
|
32
42
|
---
|
|
33
43
|
|
|
34
|
-
##
|
|
44
|
+
## Usage
|
|
35
45
|
|
|
36
46
|
```bash
|
|
37
|
-
npx
|
|
47
|
+
npx neatnode
|
|
38
48
|
```
|
|
39
49
|
|
|
40
50
|
* Enter your **project name**
|
|
@@ -42,34 +52,34 @@ npx nodeneat
|
|
|
42
52
|
* Select whether to include **CRUD** examples
|
|
43
53
|
* Install dependencies and start your project:
|
|
44
54
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
55
|
+
```bash
|
|
56
|
+
cd my-app
|
|
57
|
+
npm install
|
|
58
|
+
npm run dev
|
|
59
|
+
```
|
|
50
60
|
|
|
51
61
|
---
|
|
52
62
|
|
|
53
|
-
##
|
|
63
|
+
## Templates
|
|
54
64
|
|
|
55
|
-
###
|
|
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
|
-
###
|
|
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
|
-
###
|
|
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
|
-
##
|
|
82
|
+
## Example Project Structure
|
|
73
83
|
|
|
74
84
|
```
|
|
75
85
|
src/
|
|
@@ -83,25 +93,39 @@ src/
|
|
|
83
93
|
|
|
84
94
|
---
|
|
85
95
|
|
|
86
|
-
##
|
|
96
|
+
## Built With
|
|
87
97
|
|
|
88
98
|
* Node.js & Express
|
|
89
|
-
* Inquirer (CLI)
|
|
90
|
-
* fs-extra & path (
|
|
91
|
-
* Morgan & Winston (
|
|
92
|
-
* Joi (
|
|
93
|
-
* Helmet, Rate Limiter (
|
|
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
|
-
##
|
|
107
|
+
## Project Screenshots
|
|
98
108
|
|
|
99
|
-
|
|
100
|
-
|
|
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
|
-
|
|
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
|
-
|
|
129
|
+
## License
|
|
107
130
|
|
|
131
|
+
MIT © Aakash Gupta
|