PGos System Requirements Document

Introduction

The PGos project aims to develop a modern, enterprise-grade Paying Guest (PG) Management SaaS platform. This platform will cater to various user roles, including Super Admins, PG Owners/Managers, Tenants, and Staff, providing them with comprehensive dashboards and features to manage PG operations efficiently. The application will be built using React, Node.js, Express, PostgreSQL, and Tailwind CSS, ensuring responsiveness, security, and scalability.

System Overview

PGos is designed to streamline the management of PG accommodations by offering a robust set of features tailored to different user roles. The platform will support secure authentication, detailed dashboards, and various management functionalities, all while maintaining a professional and modern user interface.

Functional Requirements as Story Points

• As a Super Admin, I should be able to view a dashboard overview with total PGs, owners, tenants, active subscriptions, and analytics.
• As a Super Admin, I should be able to manage users, subscription plans, payments, support tickets, and system settings.
• As a PG Owner, I should be able to view occupancy rates, available rooms, and financial summaries.
• As a PG Owner, I should be able to manage properties, tenants, rent, finances, maintenance, visitors, staff, and inventory.
• As a Tenant, I should be able to view my current room, rent status, and notices.
• As a Tenant, I should be able to make online rent payments, request maintenance, and manage my profile.
• As a Staff member, I should be able to view assigned tasks, maintenance jobs, and daily work status.
• As a user, I should be able to switch between dark and light modes and receive real-time notifications.

User Personas

1. Super Admin: Oversees the entire platform, manages users, subscriptions, and system settings.
2. PG Owner/Manager: Manages properties, tenants, finances, and staff.
3. Tenant: Resides in the PG, manages personal rent payments, and requests services.
4. Staff: Handles maintenance tasks and assists with property management.

Core User Flows

• Super Admin: Logs in -> Views dashboard -> Manages users and subscriptions -> Generates reports.
• PG Owner: Logs in -> Views property dashboard -> Manages tenants and finances -> Updates property details.
• Tenant: Logs in -> Views rent status -> Makes payment -> Requests maintenance.
• Staff: Logs in -> Views assigned tasks -> Completes maintenance jobs -> Updates task status.

Visuals Colors and Theme

• primary: #1E3A8A (Deep Blue)
• primary_light: #3B82F6 (Light Blue)
• secondary: #F59E0B (Amber)
• accent: #EF4444 (Red)
• highlight: #FBBF24 (Gold)
• bg: #F3F4F6 (Light Gray)
• surface: rgba(255, 255, 255, 0.8)
• text: #111827 (Dark Gray)
• text_muted: #6B7280 (Muted Gray)
• border: rgba(209, 213, 219, 0.2)

Signature Design Concept

Interactive Dashboard Experience

The PGos platform will feature an interactive dashboard experience where users can engage with dynamic data visualizations. The landing page will showcase a live, animated map of PG locations, with each location represented by a clickable node. Hovering over a node will reveal key statistics, and clicking will transition the user to detailed analytics for that location. The dashboard will use motion/react for smooth transitions and animations, providing an engaging and informative user experience.

LANDING HERO MOTION BRIEF

The landing hero will feature a dynamic illustration of a cityscape with PG locations highlighted. As users scroll, the cityscape will animate, showing data points like occupancy rates and revenue streams flowing into a central analytics hub. This animation will loop every 10 seconds, providing a continuous visual narrative of PG management efficiency. The animation will be built using motion/react for seamless integration and responsiveness.

Interaction Model & Motion Direction

• Interaction Model: Animated
• The landing page will feature moderate scroll-triggered reveals and hover transitions, enhancing the user experience with polished animations and interactive elements.

Non-Functional Requirements

• The application must be responsive and accessible on various devices.
• Ensure high security with JWT Authentication and role-based access control.
• The system should be scalable to accommodate increasing user data and traffic.
• Maintain a modular codebase for ease of maintenance and updates.

Tech Stack

• Frontend: React, TypeScript, Vite, Tailwind CSS
• Backend: Node.js, Express.js
• Database: PostgreSQL, Prisma ORM
• Authentication: JWT
• State Management: React Query, Zustand
• Validation: Zod
• Data Visualization: Chart.js
• Form Handling: React Hook Form

Assumptions and Constraints

• The application will run on localhost:8080 during development.
• The platform will be designed for enterprise-grade scalability and security.
• Development will follow a module-by-module approach for better management and testing.

Glossary

• PG: Paying Guest
• SaaS: Software as a Service
• JWT: JSON Web Token
• ORM: Object-Relational Mapping
• KYC: Know Your Customer
• GST: Goods and Services Tax

This document outlines the comprehensive requirements for the PGos project, ensuring a robust and user-friendly PG management platform.