360-mock-server 1.1.0 → 1.1.1

package/README.md

@@ -1,190 +1,215 @@
 # 🚀 360 Mock Server
 
-Zero-config dynamic mock REST API server. Perfect for frontend development when backend isn't ready.
+**360 Mock Server** is a zero-configuration mock REST API designed for frontend developers.
+It allows you to instantly create and manage RESTful APIs **without building a backend**, making it ideal for frontend development, testing, demos, and rapid prototyping.
 
-## Installation
+
+## ✨ Why 360 Mock Server?
+
+* No backend setup required
+* Works instantly with **any endpoint**
+* Interactive CLI + REST API
+* Persistent JSON-based storage
+* Ideal for React, React Native, Vue, Angular, Redux apps
+
+
+## 📦 Installation
+
+Install globally using npm:
 
 ```bash
-# Global installation (recommended)
 npm install -g 360-mock-server
+```
+
+Or run directly using `npx` (recommended):
 
-# Or use npx (no install needed)
+```bash
 npx 360-mock-server
 ```
 
-## Quick Start
+
+## ⚡ Quick Start
 
 ```bash
-# Just run one command - that's it!
 npx 360-mock-server
 ```
 
-This will:
-1. ✅ Create `mock-data.json` automatically
-2. ✅ Start the server on port 3000
-3. ✅ Open interactive mode for easy API requests
+That’s it! 🎉
+The mock server will start at:
+
+```
+http://localhost:3000
+```
 
----
 
-## Interactive Mode (Recommended!)
+## 🧠 Interactive CLI Mode
 
-After running `npx 360-mock-server`, you get an interactive prompt:
+Once the server starts, you can interact with it directly from the terminal:
 
-```
+```text
 360-mock> POST /users {"name": "Ali", "email": "ali@test.com"}
-📤 POST /users
 ✅ Status: 201
-{ "id": 1234567890, "name": "Ali", "email": "ali@test.com" }
+{"id": 1737745200000, "name": "Ali", "email": "ali@test.com"}
 
 360-mock> GET /users
-📤 GET /users
 ✅ Status: 200
-[{ "id": 1234567890, "name": "Ali", "email": "ali@test.com" }]
+[{"id": 1737745200000, "name": "Ali", "email": "ali@test.com"}]
 
-360-mock> POST /products {"name": "Laptop", "price": 999}
-360-mock> GET /products
-360-mock> DELETE /users/1234567890
-360-mock> exit
+360-mock> DELETE /users/1737745200000
+✅ Status: 200
 ```
 
-### Interactive Commands
-
-| Command | Example |
-|---------|---------|
-| GET | `GET /users` |
-| POST | `POST /users {"name": "Ali"}` |
-| PUT | `PUT /users/123 {"name": "Updated"}` |
-| PATCH | `PATCH /users/123 {"email": "new@test.com"}` |
-| DELETE | `DELETE /users/123` |
-| list | Show all resources |
-| clear | Clear screen |
-| help | Show help |
-| exit | Exit |
 
----
+## 📟 CLI Commands (Interactive Mode)
 
-## CLI Commands
+| Command                                | Description                  |
+| -------------------------------------- | ---------------------------- |
+| `GET /users`                           | Fetch all users              |
+| `GET /users/123`                       | Fetch user by ID             |
+| `POST /users {"name":"Ali"}`           | Create a new user            |
+| `PUT /users/123 {"name":"New"}`        | Replace entire resource      |
+| `PATCH /users/123 {"email":"x@y.com"}` | Update specific fields       |
+| `DELETE /users/123`                    | Delete resource              |
+| `list`                                 | Show all available resources |
+| `clear`                                | Clear terminal screen        |
+| `help`                                 | Show help                    |
+| `exit`                                 | Exit interactive mode        |
 
-| Command | Description |
-|---------|-------------|
-| `360-mock` | Start server + interactive mode |
-| `360-mock start` | Start server only |
-| `360-mock init` | Create mock-data.json |
-| `360-mock list` | Show available resources |
-| `360-mock reset` | Clear all data |
+## 🧪 Using with Postman / REST Clients
 
-### Options
+**Base URL**
 
-```bash
-360-mock --port 4000             # Custom port
-360-mock --file db.json          # Custom data file
-360-mock --help                  # Show help
-360-mock --version               # Show version
 ```
-
----
-
-## API Endpoints
-
-### Any endpoint works automatically!
-
-Just POST to any endpoint - it creates the resource:
-
-```bash
-# These all work without configuration:
-POST /users
-POST /products  
-POST /orders
-POST /anything-you-want
+http://localhost:3000
 ```
 
-### Full CRUD Operations
+### Example Endpoints
 
-| Method | Endpoint | Description |
-|--------|----------|-------------|
-| GET | `/users` | Get all users |
-| GET | `/users/1` | Get user by ID |
-| POST | `/users` | Create user |
-| PUT | `/users/1` | Replace user |
-| PATCH | `/users/1` | Update user |
-| DELETE | `/users/1` | Delete user |
-| DELETE | `/users` | Delete all users |
+| Method | Endpoint     | Body                          |
+| ------ | ------------ | ----------------------------- |
+| GET    | `/users`     | —                             |
+| GET    | `/users/123` | —                             |
+| POST   | `/users`     | `{ "name": "Ali" }`           |
+| PUT    | `/users/123` | `{ "name": "Updated" }`       |
+| PATCH  | `/users/123` | `{ "email": "new@test.com" }` |
+| DELETE | `/users/123` | —                             |
 
-### Query Parameters
+**Required Headers**
 
-```bash
-GET /users?name=john           # Filter by name
-GET /users?_sort=name          # Sort by field
-GET /users?_order=desc         # Sort order
-GET /users?_limit=10&_page=2   # Pagination
+```
+Content-Type: application/json
 ```
 
----
 
-## Frontend Examples
+## 🔌 Frontend Integration Examples
 
-### Fetch API
+<details open>
+<summary><strong>Fetch API</strong></summary>
 
 ```javascript
-// Create
-const user = await fetch('http://localhost:3000/users', {
+const API = 'http://localhost:3000';
+
+// CREATE
+await fetch(`${API}/users`, {
   method: 'POST',
   headers: { 'Content-Type': 'application/json' },
   body: JSON.stringify({ name: 'Ali', email: 'ali@test.com' })
-}).then(r => r.json());
-
-// Read all
-const users = await fetch('http://localhost:3000/users').then(r => r.json());
+});
 
-// Read one
-const user = await fetch('http://localhost:3000/users/1').then(r => r.json());
+// READ
+const users = await fetch(`${API}/users`).then(res => res.json());
 
-// Update
-await fetch('http://localhost:3000/users/1', {
+// UPDATE
+await fetch(`${API}/users/123`, {
   method: 'PATCH',
   headers: { 'Content-Type': 'application/json' },
-  body: JSON.stringify({ name: 'Ali Updated' })
+  body: JSON.stringify({ name: 'Updated' })
 });
 
-// Delete
-await fetch('http://localhost:3000/users/1', { method: 'DELETE' });
+// DELETE
+await fetch(`${API}/users/123`, { method: 'DELETE' });
 ```
 
-### Axios
+</details>
+
+<details>
+<summary><strong>Axios</strong></summary>
 
 ```javascript
 import axios from 'axios';
-const api = axios.create({ baseURL: 'http://localhost:3000' });
 
-// Create
-const { data: user } = await api.post('/users', { name: 'Ali' });
+const API = 'http://localhost:3000';
+
+// CREATE
+await axios.post(`${API}/users`, {
+  name: 'Ali',
+  email: 'ali@test.com'
+});
+
+// READ
+const { data: users } = await axios.get(`${API}/users`);
+
+// UPDATE
+await axios.patch(`${API}/users/123`, {
+  name: 'Updated'
+});
+
+// DELETE
+await axios.delete(`${API}/users/123`);
+```
+
+</details>
+
 
-// Read
-const { data: users } = await api.get('/users');
+## ⚙️ CLI Options
 
-// Update
-await api.patch(`/users/${id}`, { name: 'Updated' });
+| Option   | Description    | Default          |
+| -------- | -------------- | ---------------- |
+| `--port` | Server port    | `3000`           |
+| `--file` | Data file name | `mock-data.json` |
 
-// Delete
-await api.delete(`/users/${id}`);
+### Examples
+
+```bash
+npx 360-mock-server --port 4000
+npx 360-mock-server --file db.json
 ```
 
----
 
-## Features
+## 🛠 Additional Commands
+
+| Command          | Description                             |
+| ---------------- | --------------------------------------- |
+| `360-mock start` | Start server only (no interactive mode) |
+| `360-mock init`  | Create an empty data file               |
+| `360-mock list`  | List all resources                      |
+| `360-mock reset` | Clear all stored data                   |
+
+
+## 🌟 Features
+
+* ✅ Zero-config setup
+* ✅ Supports **any REST endpoint**
+* ✅ Full CRUD operations
+* ✅ Auto-generated unique IDs
+* ✅ Automatic timestamps (`createdAt`, `updatedAt`)
+* ✅ Persistent JSON storage
+* ✅ CORS enabled
+* ✅ Works with Postman & frontend apps
+* ✅ Perfect for mock APIs & demos
 
-- ✅ **Zero config** - Works out of the box
-- ✅ **Any endpoint** - Auto-creates resources
-- ✅ **Full CRUD** - GET, POST, PUT, PATCH, DELETE
-- ✅ **Filtering** - Query parameter support
-- ✅ **Sorting** - `?_sort=field&_order=desc`
-- ✅ **Pagination** - `?_limit=10&_page=1`
-- ✅ **Auto IDs** - Generated automatically
-- ✅ **Timestamps** - createdAt, updatedAt
-- ✅ **CORS enabled** - Works with any frontend
 
----
+## 💾 Data Storage
 
-## License
+All data is stored locally in:
+
+```
+mock-data.json
+```
+
+This file is automatically created and updated in your project directory.
+
+## 📄 License
 
 MIT © [zahidrahimoon](https://github.com/zahidrahimoon)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "360-mock-server",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "🚀 Zero-config dynamic mock REST API server for frontend developers",
   "main": "lib/server.js",
   "bin": {