mksrvr 2.0.0 → 2.0.1
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/package.json +1 -1
- package/readme.md +31 -0
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Installation
|
|
2
|
+
|
|
3
|
+
install in new folder
|
|
4
|
+
```
|
|
5
|
+
npx mksrvr <folder-name>
|
|
6
|
+
```
|
|
7
|
+
|
|
8
|
+
install in current folder
|
|
9
|
+
```
|
|
10
|
+
npx mksrvr .
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Description
|
|
14
|
+
|
|
15
|
+
`mksrvr` is a lightweight CLI tool designed to quickly scaffold a Node.js server environment. It provides a structured boilerplate with essential configurations, allowing developers to jump straight into building their application logic without manual setup.
|
|
16
|
+
|
|
17
|
+
## Features
|
|
18
|
+
|
|
19
|
+
- **Instant Setup**: Scaffolds a complete project structure in seconds.
|
|
20
|
+
- **Best Practices**: Follows a clean and maintainable directory layout for routes, controllers, and middleware.
|
|
21
|
+
- **Pre-configured**: Includes essential middleware like CORS, environment variable support, and request logging.
|
|
22
|
+
- **Developer Experience**: Integrated hot-reloading for a seamless development workflow.
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
After scaffolding your project, navigate to the directory and start the development server:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npm run dev
|
|
30
|
+
```
|
|
31
|
+
|