krsyer-server-monitor-pro 1.0.4 → 1.0.6

package/guestguru-api/.idea/guestguru-api.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/guestguru-api/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="21" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/guestguru-api/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/guestguru-api.iml" filepath="$PROJECT_DIR$/.idea/guestguru-api.iml" />
+    </modules>
+  </component>
+</project>

package/guestguru-api/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/guestguru-api/API_DESIGN_GUIDE.md

@@ -0,0 +1,140 @@
+# SaaS PG Management App - Frontend Design & API Guide
+
+This guide outlines the backend API endpoints mapped to the required mobile screens for the SaaS PG Management Application. It is divided by **User Roles** (Super Admin, PG Owner, Resident).
+
+## 🌍 Base URL
+`http:// <server-ip> :5000/api`
+
+---
+
+## 🔐 Authentication Module
+**Screens**: Login, Sign Up, Splash Screen
+
+### 1. Login
+*   **Endpoint**: `POST /auth/signin`
+*   **Payload**: `{ "email": "...", "password": "..." }`
+*   **Response**: Returns `accessToken`, `role`, `ownerId`.
+*   **UI Design Notes**:
+    *   Simple form with Email & Password.
+    *   **Action**: Store `accessToken` securely (AsyncStorage).
+    *   **Logic**: Redirect based on `role` ('superadmin' -> SA Dashboard, 'admin' -> Owner Dashboard, 'customer' -> Resident App).
+
+### 2. Sign Up (PG Owners)
+*   **Endpoint**: `POST /auth/signup`
+*   **Payload**: `{ "name": "...", "email": "...", "password": "...", "phone": "...", "role": "admin" }`
+*   **UI Design Notes**:
+    *   Registration form for new PG Owners.
+    *   Show "Free Plan Active" success message after signup.
+
+---
+
+## 👑 Super Admin App
+**Target Audience**: You (Platform Owner)
+
+### 1. Dashboard / Owner Management
+Manage the PG Owners who use your SaaS platform.
+*   **Endpoint**: `GET /superadmin/owners`
+*   **Display Data**: List of owners (Name, Email, Plan Name, Status).
+*   **UI Design Notes**:
+    *   List view card for each PG Owner.
+    *   **Toggle Switch**: "Block/Unblock" owner.
+    *   **Endpoint**: `PUT /superadmin/owners/:id/toggle-block`
+
+---
+
+## 🏢 PG Owner App (SaaS Tenant)
+**Target Audience**: Hostel/PG Managers
+
+### 1. Owner Dashboard (Home)
+Overview of their PG's performance.
+*   **Endpoint**: `GET /dashboard/admin`
+*   **Display Data**:
+    *   **Stats Cards**: Total Rooms, Available Beds, Active Tenants.
+    *   **Financials**: Total Revenue, Collected, Pending (Hardcoded trend +12%).
+    *   **Recent Activity**: Feed of "Rent Received", "New Assignment".
+*   **UI Design Notes**:
+    *   Rich graphical widgets (Pie chart for Occupancy).
+    *   Scrollable "Activity Feed".
+
+### 2. Pending Dues Screen
+List of tenants who haven't paid rent.
+*   **Endpoint**: `GET /dashboard/admin/pending-rents?month=12&year=2025`
+*   **Display Data**: Total Pending Amount, List of Tenants (Name, Room, Due Amount).
+*   **UI Design Notes**:
+    *   **Filter**: Month/Year picker.
+    *   **List Item**: Tenant Name, Room No, RED text for "Due: ₹5000".
+    *   **Action**: "Remind" button (WhatsApp intent).
+
+### 3. Room Management
+*   **List Rooms**: `GET /rooms`
+    *   *Grid view* of rooms showing Room No, Occupancy (2/3), Floor.
+*   **Add Room**: `POST /rooms`
+    *   Fields: No, Floor, Capacity, Price, Amenities.
+*   **Edit Room**: `PUT /rooms/:id`
+*   **Delete**: `DELETE /rooms/:id`
+*   **UI Design Notes**:
+    *   Floating Action Button (+) to add room.
+    *   Visual indicator for "Full" rooms (Red) vs "Available" (Green).
+
+### 4. Tenant Management
+*   **List Tenants**: `GET /tenants?status=Active`
+    *   *List view* with Search Bar.
+    *   Shows: Details, Room No, Status tag (Active/Due Payment).
+*   **Onboard Tenant**: `POST /tenants`
+    *   **Form**: Name, Phone, Email, Assign Room (Dropdown), Rent Amount.
+    *   **Uploads**: Profile Pic, ID Proof (Multipart form).
+*   **Tenant Details**: `GET /tenants/:id`
+    *   Profile View, Payment History, Assigned Room.
+    *   **Actions**: 
+        *   `POST /tenants/:id/move-out` (End stay).
+        *   `DELETE /tenants/:id` (Archive).
+
+### 5. Collection (Cash Entry)
+Record a payment made offline.
+*   **Endpoint**: `POST /payments` (or `/tenants/collect-rent`)
+*   **Payload**: `{ "tenantId": "...", "amount": 5000, "type": "monthly_rent" }`
+*   **UI Design Notes**:
+    *   "Collect Rent" modal on Tenant Details screen.
+    *   Auto-updates Tenant status from "Due" to "Active".
+
+### 6. Subscription Plan
+Manage their SaaS subscription.
+*   **Endpoint**: `GET /subscriptions`
+    *   Shows: Current Plan (Free/Premium), Expiry.
+*   **Upgrade**: `POST /subscriptions/upgrade`
+    *   UI: Pricing Cards (Basic, Premium) -> Payment Gateway -> Success.
+
+---
+
+## 🏠 Resident App (Tenant)
+**Target Audience**: Students/Professionals living in PG
+
+### 1. Resident Home
+*   **Endpoint**: `GET /dashboard/customer`
+*   **Display Data**:
+    *   **Profile**: Name, Room Number.
+    *   **Announcements**: Carousel of latest notices from Owner.
+    *   **Recent Payments**: List of last 5 transactions.
+*   **UI Design Notes**:
+    *   Clean, welcoming header "Welcome Back, [Name]".
+    *   **Quick Action**: "Pay Rent" button.
+
+### 2. Announcements
+*   **Endpoint**: `GET /dashboard/announcements`
+*   **Display Data**: List of notices (e.g., "Water heater maintenance").
+
+### 3. Payment History
+*   **Endpoint**: `GET /payments/my-history`
+*   **Display Data**: List of all payments (Date, Amount, Status).
+*   **UI Design Notes**:
+    *   Card style for each transaction.
+    *   Green badge for "Completed", Red for "Failed".
+
+---
+
+## ⚖️ Legal & Compliance
+**Common Screens**: Settings > Terms / Privacy
+
+*   **Terms**: `GET /legal/terms`
+*   **Privacy**: `GET /legal/privacy`
+*   **UI Design Notes**: Simple text/webview render.

package/guestguru-api/API_DOCUMENTATION.md

@@ -0,0 +1,504 @@
+# PG Management System - Backend API
+
+## Overview
+This is a Node.js/Express backend for a SaaS-based PG Management application. It supports Authentication, Role-based access control (Superadmin, Admin, Customer), Room Management, and Payment processing (Stubbed/integrated logic).
+
+## Base URL
+`http://localhost:5000`
+
+## Features
+- **Authentication**: JWT based Login/Signup.
+- **Roles**:
+  - `superadmin`: Full access.
+  - `admin`: Manage rooms, view all payments.
+  - `customer`: View own dashboard, make payments.
+- **Payments**: Simulates payment gateway intent and confirmation.
+- **Database**: SQLite (Development), configurable for Postgres/MySQL.
+
+## Setup
+1. `npm install`
+2. `npm start`
+3. Super Admin default credentials: `admin@pg.com` / `admin123`
+
+## Postman Collection
+Copy the JSON below and import it into Postman.
+
+```json
+{
+	"info": {
+		"_postman_id": "pg-backend-collection",
+		"name": "PG Management API",
+		"description": "Postman collection for PG Management SaaS Backend",
+		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+	},
+	"item": [
+		{
+			"name": "Auth",
+			"item": [
+				{
+					"name": "Signup (Customer)",
+					"request": {
+						"method": "POST",
+						"header": [],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"name\": \"John Customer\",\n    \"email\": \"customer@example.com\",\n    \"password\": \"password123\",\n    \"phone\": \"9876543210\",\n    \"role\": \"customer\"\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "{{url}}/api/auth/signup",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"auth",
+								"signup"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Signin (Admin)",
+					"event": [
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"var jsonData = pm.response.json();",
+									"if(jsonData.accessToken) {",
+									"    pm.environment.set(\"token\", jsonData.accessToken);",
+									"    console.log(\"Token set successfully\");",
+									"}"
+								],
+								"type": "text/javascript"
+							}
+						}
+					],
+					"request": {
+						"method": "POST",
+						"header": [],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"email\": \"admin@pg.com\",\n    \"password\": \"admin123\"\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "{{url}}/api/auth/signin",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"auth",
+								"signin"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Signin (Customer)",
+					"event": [
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"var jsonData = pm.response.json();",
+									"if(jsonData.accessToken) {",
+									"    pm.environment.set(\"token\", jsonData.accessToken);",
+									"}"
+								],
+								"type": "text/javascript"
+							}
+						}
+					],
+					"request": {
+						"method": "POST",
+						"header": [],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"email\": \"customer@example.com\",\n    \"password\": \"password123\"\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "{{url}}/api/auth/signin",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"auth",
+								"signin"
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		},
+		{
+			"name": "Rooms",
+			"item": [
+				{
+					"name": "Get All Rooms",
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"url": {
+							"raw": "{{url}}/api/rooms",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"rooms"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Create Room (Admin)",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"roomNumber\": \"101\",\n    \"floor\": 1,\n    \"capacity\": 3,\n    \"pricePerMonth\": 6000,\n    \"amenities\": \"WiFi, TV\"\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "{{url}}/api/rooms",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"rooms"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Update Room (Admin)",
+					"request": {
+						"method": "PUT",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"pricePerMonth\": 6500,\n    \"floor\": 2,\n    \"amenities\": \"WiFi, TV, AC\",\n    \"isMaintenance\": true\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "{{url}}/api/rooms/:id",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"rooms",
+								":id"
+							],
+							"variable": [
+								{
+									"key": "id",
+									"value": "ENTER_ROOM_ID_HERE"
+								}
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Delete Room (Admin)",
+					"request": {
+						"method": "DELETE",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"url": {
+							"raw": "{{url}}/api/rooms/:id",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"rooms",
+								":id"
+							],
+							"variable": [
+								{
+									"key": "id",
+									"value": "ENTER_ROOM_ID_HERE"
+								}
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		},
+		{
+			"name": "Payments",
+			"item": [
+				{
+					"name": "Create Payment Intent",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"amount\": 6000,\n    \"type\": \"monthly_rent\"\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "{{url}}/api/payments/create-intent",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"payments",
+								"create-intent"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Confirm Payment",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n    \"paymentId\": \"PASTE_PAYMENT_ID_HERE\",\n    \"transactionId\": \"TXN_99999\",\n    \"method\": \"upi\"\n}",
+							"options": {
+								"raw": {
+									"language": "json"
+								}
+							}
+						},
+						"url": {
+							"raw": "{{url}}/api/payments/confirm",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"payments",
+								"confirm"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "My History (Customer)",
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"url": {
+							"raw": "{{url}}/api/payments/my-history",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"payments",
+								"my-history"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "All Payments (Admin)",
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"url": {
+							"raw": "{{url}}/api/payments?status=pending",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"payments"
+							],
+							"query": [
+								{
+									"key": "status",
+									"value": "pending",
+									"description": "Optional filter: pending, completed, failed"
+								}
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		},
+		{
+			"name": "Dashboard",
+			"item": [
+				{
+					"name": "Admin Stats",
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"url": {
+							"raw": "{{url}}/api/dashboard/admin",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"dashboard",
+								"admin"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Customer Dashboard",
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"url": {
+							"raw": "{{url}}/api/dashboard/customer",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"dashboard",
+								"customer"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Announcements",
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "x-access-token",
+								"value": "{{token}}",
+								"type": "text"
+							}
+						],
+						"url": {
+							"raw": "{{url}}/api/dashboard/announcements",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"dashboard",
+								"announcements"
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		}
+	],
+	"variable": [
+		{
+			"key": "url",
+			"value": "http://localhost:5000",
+			"type": "string"
+		}
+	]
+}
+```