mksrvr 2.0.0 → 2.0.2

package/bin/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import fs from "fs";
 import path from "path";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mksrvr",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "type": "module",
   "bin": {
     "mksrvr": "./bin/index.js"

package/readme.md

@@ -0,0 +1,51 @@
+# Installation
+
+install in new folder
+```
+npx mksrvr <folder-name>
+```
+
+install in current folder
+```
+npx mksrvr .
+```
+
+## Description
+
+`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.
+
+## Features
+
+- **Instant Setup**: Scaffolds a complete project structure in seconds.
+- **Best Practices**: Follows a clean and maintainable directory layout for routes, controllers, and middleware.
+- **Pre-configured**: Includes essential middleware like CORS, environment variable support, and request logging.
+- **Developer Experience**: Integrated hot-reloading for a seamless development workflow.
+
+## Usage
+
+After scaffolding your project, navigate to the directory and start the development server:
+
+```bash
+npm run dev
+```
+
+
+## Folder Structure
+
+```text
+.
+├── node_modules/
+├── src/
+│   ├── config/         # Configuration files
+│   ├── controllers/    # Request handlers
+│   ├── middleware/     # Custom middleware
+│   ├── models/         # Database models
+│   ├── routes/         # Route definitions
+│   ├── services/       # Business logic
+│   ├── app.js          # Express application setup
+├── .env                # Environment variables
+├── .gitignore          # Git ignore rules
+├── package.json        # Project metadata and dependencies
+├── server.js           # Server entry point
+```
+