Property Management Suite - Documentation

Version: 1.0
Last Updated: November 2025

Executive Summary

The Property Management Suite (PMS) is a comprehensive, AI-powered property management platform designed to streamline operations for property managers and enhance the experience for tenants. The system consists of multiple integrated components:

Core Components

Backend Service (tenant_portal_backend)
- NestJS/TypeScript REST API
- PostgreSQL database with Prisma ORM
- JWT-based authentication and role-based access control
- Comprehensive feature set including leases, maintenance, payments, inspections, and more
Frontend Application (tenant_portal_app)
- React/TypeScript web application
- "Digital Twin OS" design system (dark, glassmorphic UI)
- Role-based dashboards for tenants and property managers
- Real-time notifications and messaging
Mobile Application (tenant_portal_mobile)
- React Native mobile app
- Biometric authentication
- Core tenant features (payments, maintenance, messaging)
ML Service (rent_optimization_ml)
- Python/FastAPI microservice
- XGBoost-based rent prediction models
- Market data integration (Zillow, Rentometer)
- Batch prediction support

Key Features

AI-Powered Capabilities
- Voice AI agents for call handling and leasing
- Predictive maintenance with ML
- AI chatbot for tenant support
- Rent optimization recommendations
- Payment risk assessment
Core Functionality
- Property and unit management
- Lease lifecycle management
- Maintenance request tracking with SLA monitoring
- Payment processing with autopay
- Document management and e-signatures
- Inspection workflows
- Rental application processing
- Financial reporting and QuickBooks integration
Integration Ecosystem
- QuickBooks for accounting
- RentCast for market data
- KeyCheck for inspections (planned)
- Email and SMS notifications
- Payment gateways (Stripe)

Documentation Structure

The documentation is organized into logical categories within the /docs directory:

docs/
├── README.md                          # This file - documentation index
│
├── architecture/                      # System architecture and design
│   ├── comprehensive-analysis-report.md
│   ├── comprehensive-analysis-report-part2.md
│   ├── comprehensive-analysis-report-part3.md
│   ├── ai-voice-agent-architecture.md
│   ├── app-architecture.md
│   ├── adr.md
│   └── schema-validation-report.md
│
├── setup/                            # Environment setup and installation
│   ├── environment-setup-backend.md
│   ├── environment-setup-app.md
│   ├── phase-1-seed-implementation.md
│   ├── phase-2-environment-setup.md
│   ├── complete-execution-guide.md
│   ├── admin-setup.md
│   ├── e2e-setup.md
│   ├── quick-start-leasing-agent.md
│   ├── quick-start-ml-training.md
│   ├── ml-database-extraction-guide.md
│   └── ml-scripts-readme.md
│
├── implementation/                    # Implementation status and phases
│   ├── phase-1-complete.md
│   ├── phase-2-complete.md
│   ├── phase-3-complete.md
│   ├── phase-4-complete.md
│   ├── phase-5-complete.md
│   ├── phase-6-complete.md
│   ├── phase-1-implementation-complete.md
│   ├── phase-2-implementation-complete.md
│   ├── phase-3-implementation-complete.md
│   ├── phase-1-next-steps-complete.md
│   ├── phase-2-next-steps-complete.md
│   ├── phase-3-next-steps-complete.md
│   ├── phase-4-next-steps-complete.md
│   ├── phase-5-next-steps-complete.md
│   ├── phase-6-next-steps-complete.md
│   ├── all-phases-implementation-plan.md
│   ├── all-phases-complete-implementation.md
│   ├── implementation-status.md
│   ├── all-features-implementation-status.md
│   ├── comprehensive-feature-implementation.md
│   ├── acceptance-criteria-verification.md
│   ├── endpoint-implementation-status.md
│   ├── endpoint-audit-and-testing.md
│   ├── real-world-data-migration-plan.md
│   ├── production-readiness-audit.md
│   ├── app-implementation-summary.md
│   ├── app-domain-implementation-status.md
│   ├── production-ready-implementation-summary.md
│   └── ml-schema-extension-complete.md
│
├── api/                              # API documentation
│   ├── api-specs.md
│   ├── api-inventory.md
│   ├── frontend-api-usage.md
│   ├── inspection-service.md
│   ├── leasing-agent-api-reference.md
│   └── postman-seed-api-tests.json
│
├── testing/                          # Testing guides and reports
│   ├── testing.md
│   ├── e2e-test-coverage.md
│   ├── comprehensive-testing-plan.md
│   ├── testing-implementation-status.md
│   ├── backend-testing.md
│   ├── testing-quick-start.md
│   ├── testing-implementation-summary.md
│   ├── testing-complete-summary.md
│   ├── testing-final-report.md
│   ├── testing-status.md
│   ├── workflow-testing-guide.md
│   ├── app-testing-guide.md
│   ├── app-testing-improvements.md
│   ├── leasing-agent-testing-guide.md
│   ├── mobile-app-testing-guide.md
│   └── mobile-app-login-test-guide.md
│
├── ai-ml/                            # AI and ML documentation
│   ├── ai-implementation-executive-summary.md
│   ├── ai-implementation-feasibility-analysis.md
│   ├── ai-implementation-presentation-slides.md
│   ├── ai-implementation-roadmap.md
│   ├── ai-chatbot-implementation.md
│   ├── ai-chatbot-ui-integration.md
│   ├── ai-leasing-agent-implementation.md
│   ├── ai-features-documentation.md
│   ├── ai-features-phase-3-complete.md
│   ├── ai-configuration.md
│   ├── ai-monitoring-guide.md
│   ├── ai-services-integration-plan.md
│   ├── chatbot-ai-setup.md
│   ├── ai-operating-system.md
│   ├── ai-operating-system-quick-start.md
│   ├── ai-feature-integration-executive-summary.md
│   ├── ai-feature-integration-plan-architecture.txt
│   ├── ai-features-review.md
│   ├── rent-optimization-implementation.md
│   ├── ai-rent-optimization-status.md
│   ├── ml-training-guide.md
│   ├── llm-platform-evaluation.md
│   ├── ai-features-development-plan-files.md
│   └── ai-features-development-plan.md
│
├── integrations/                     # Third-party integrations
│   ├── quickbooks-integration-status.md
│   ├── quickbooks-integration-completion-summary.md
│   ├── quickbooks-integration-testing-complete.md
│   ├── quickbooks-sandbox-testing-guide.md
│   ├── quickbooks-testing-guide.md
│   ├── rentcast-integration-success.md
│   ├── keycheck-integration-plan.md
│   └── market-data-integration-status.md
│
├── guides/                           # User guides and how-to docs
│   ├── email-notifications-guide.md
│   ├── rent-notifications-guide.md
│   ├── overall-user-guide.md
│   ├── end-user-guide.md
│   ├── quick-reference.md
│   ├── functionality.md
│   ├── migration-guide.md
│   ├── ui-ux-handoff.md
│   ├── tablet-layout-guidelines.md
│   ├── msw-setup.md
│   ├── backend-connection-test.md
│   ├── backend-integration-next-steps.md
│   ├── backend-integration-summary.md
│   ├── test-data-guide.md
│   │
│   ├── wiki/                         # Feature-specific wiki pages
│   │   ├── home.md
│   │   ├── authentication.md
│   │   ├── changelog.md
│   │   ├── documentation-update-2025-01-05.md
│   │   ├── expense-tracker.md
│   │   ├── lease-management.md
│   │   ├── maintenance.md
│   │   ├── messaging.md
│   │   ├── payments.md
│   │   ├── rent-estimator.md
│   │   ├── rental-application.md
│   │   ├── routing-migration-guide.md
│   │   ├── routing-system.md
│   │   └── tenant-screening.md
│   │
│   ├── components/                   # Component documentation
│   │   ├── app-readme.md
│   │   ├── app-main-readme.md
│   │   ├── app-changelog.md
│   │   ├── app-pr-description.md
│   │   ├── app-performance-optimization.md
│   │   ├── app-report-state.md
│   │   ├── app-report-ui-refresh.md
│   │   ├── app-follow-ups.md
│   │   ├── app-follow-ups-update.md
│   │   ├── app-follow-ups-status.md
│   │   ├── app-follow-ups-progress.md
│   │   ├── app-follow-ups-implementation-summary.md
│   │   ├── app-follow-ups-complete.md
│   │   ├── App/
│   │   ├── AuthContext/
│   │   ├── ExpenseTrackerPage/
│   │   ├── LeaseManagementPage/
│   │   ├── LoginPage/
│   │   ├── MaintenanceDashboard/
│   │   ├── MessagingPage/
│   │   ├── MyLeasePage/
│   │   ├── PaymentsPage/
│   │   ├── RentalApplicationPage/
│   │   ├── RentalApplicationsManagementPage/
│   │   ├── RentEstimatorPage/
│   │   └── SignupPage/
│   │
│   └── ui-wireframes/                # UI wireframe diagrams
│       ├── ApplicationsHub.svg
│       ├── AppShell.svg
│       ├── AuditLog.svg
│       ├── CreateAccount.svg
│       ├── ExpensesOverview.svg
│       ├── LeasesOverview.svg
│       ├── LoginScreen.svg
│       ├── MaintenanceDashboard.svg
│       ├── MessagingInbox.svg
│       ├── PaymentsConsole.svg
│       ├── RentEstimator.svg
│       └── TenantShell.svg
│
├── troubleshooting/                  # Debugging and fixes
│   ├── quick-fixes.md
│   ├── ml-service-down-guide.md
│   ├── debugging-blank-pages.md
│   ├── resolving-blocked-push.md
│   ├── app-page-rendering-fixes.md
│   ├── routing-fixes-summary.md
│   ├── routing-test-report.md
│   ├── ml-cors-origins-fix.md
│   ├── ml-pydantic-v2-fix.md
│   └── ml-database-url-fix.md
│
├── project-management/               # Project planning and status
│   ├── github-setup-complete.md
│   ├── github-issues-complete.md
│   ├── project-board-setup-complete.md
│   ├── github-project-board.md
│   ├── issue-creation-guide.md
│   ├── user-stories.md
│   ├── phase-1-task-breakdown.md
│   ├── lease-lifecycle-upgrade-plan.md
│   ├── maintenance-modernization-rollout.md
│   ├── tablet-implementation-summary.md
│   ├── upgraded-tablet-implementation-plan.md
│   ├── property-management-suite-marketing.md
│   ├── untitled-plan-connect-frontend-to-backend.md
│   └── pdf-generation-instructions.md
│
├── mobile/                           # Mobile app documentation
│   ├── mobile-app-mvp-plan.md
│   ├── mobile-app-mvp-complete.md
│   ├── mobile-app-phase-1-complete.md
│   ├── mobile-app-phase-2-progress.md
│   ├── mobile-app-phase-2.5-registration-complete.md
│   ├── mobile-app-phase-2.6-biometric-complete.md
│   ├── mobile-app-phase-2.7-profile-complete.md
│   └── mobile-app-phase-2.8-navigation-complete.md
│
└── generations/                      # Cross-cutting generation/chronology index
    └── README.md

Documentation Index

Architecture & Design

Comprehensive system architecture, design decisions, and technical specifications.

Comprehensive Analysis Report - Complete feature set, gap analysis, and production readiness assessment
Comprehensive Analysis Report Part 2 - Functionality gaps and competitive analysis
Comprehensive Analysis Report Part 3 - Additional analysis and recommendations
AI Voice Agent Architecture - Architecture for voice AI receptionist and leasing agent
App Architecture - Frontend application architecture and design patterns
Architecture Decision Records (ADR) - Key architectural decisions and rationale
Schema Validation Report - Database schema validation and analysis

Setup & Installation

Environment setup, installation guides, and initial configuration.

Backend Environment Setup - Backend service setup and configuration
Frontend Environment Setup - Frontend application setup
Phase 1: Seed Implementation - Database seeding and initial data setup
Phase 2: Environment Setup - Development environment configuration
Complete Execution Guide - End-to-end setup instructions
Admin Setup - Administrator account configuration
E2E Setup - End-to-end testing environment setup
Quick Start: Leasing Agent - Quick setup for AI leasing agent
Quick Start: ML Training - Quick setup for ML service training
ML Database Extraction Guide - Guide for extracting data for ML training
ML Scripts README - Documentation for ML service scripts

Implementation Status

Phase completion reports, implementation status, and feature tracking.

Phase 1 Complete - Phase 1 implementation summary
Phase 2 Complete - Phase 2 implementation summary
Phase 3 Complete - Phase 3 implementation summary
Phase 4 Complete - Phase 4 implementation summary
Phase 5 Complete - Phase 5 implementation summary
Phase 6 Complete - Phase 6 implementation summary
All Phases Implementation Plan - Complete implementation roadmap
Implementation Status - Current implementation status overview
Acceptance Criteria Verification - User story acceptance criteria verification
Production Readiness Audit - Production deployment readiness assessment
Real-World Data Migration Plan - Plan for migrating production data

API Documentation

API specifications, endpoints, and integration guides.

API Specifications - Complete API endpoint documentation
API Inventory - Comprehensive list of all API endpoints
Frontend API Usage - Guide for frontend developers using the API
Inspection Service API - Inspection service API documentation
Leasing Agent API Reference - AI leasing agent API endpoints
Postman API Tests - Postman collection for API testing

Testing

Testing guides, test coverage reports, and testing strategies.

Testing Overview - General testing documentation
E2E Test Coverage - End-to-end test coverage report
Comprehensive Testing Plan - Complete testing strategy
Backend Testing - Backend service testing guide
Frontend Testing Guide - Frontend application testing
Workflow Testing Guide - Workflow engine testing
Leasing Agent Testing Guide - AI leasing agent testing
Mobile App Testing Guide - Mobile application testing

AI & Machine Learning

AI features, ML models, and intelligent automation documentation.

AI Implementation Executive Summary - High-level AI implementation overview
AI Implementation Roadmap - AI feature development roadmap
AI Chatbot Implementation - Chatbot feature implementation
AI Leasing Agent Implementation - AI-powered leasing agent
AI Monitoring Guide - Monitoring and metrics for AI services
AI Configuration - AI service configuration guide
AI Services Integration Plan - Integration plan for AI services
Chatbot AI Setup - Chatbot setup and configuration
AI Operating System - AI system architecture and operations
ML Training Guide - Machine learning model training guide
Rent Optimization Implementation - Rent optimization ML feature

Integrations

Third-party service integrations and API connections.

QuickBooks Integration Status - QuickBooks accounting integration status
QuickBooks Testing Guide - QuickBooks integration testing
RentCast Integration Success - RentCast market data integration
KeyCheck Integration Plan - KeyCheck inspection integration plan
Market Data Integration Status - Market data services integration

User Guides

How-to guides, user documentation, and feature walkthroughs.

Email Notifications Guide - Email notification configuration and usage
Rent Notifications Guide - Rent payment notification setup
Overall User Guide - Complete user guide for the system
End User Guide - End-user focused documentation
Quick Reference - Quick reference guide for common tasks
Migration Guide - System migration and upgrade guide
UI/UX Handoff - Design handoff documentation
Tablet Layout Guidelines - Tablet-specific UI guidelines
MSW Setup - Mock Service Worker setup for development
Test Data Guide - Guide for creating and using test data

Wiki Documentation

Feature-specific wiki pages with detailed information.

Home - Wiki home page
Authentication - Authentication system documentation
Lease Management - Lease management features
Maintenance - Maintenance request system
Payments - Payment processing features
Messaging - Messaging system
Rental Application - Rental application process
Rent Estimator - Rent estimation tool
Expense Tracker - Expense tracking features
Routing System - Application routing architecture
Tenant Screening - Tenant screening process

Troubleshooting

Debugging guides, fix documentation, and problem resolution.

Quick Fixes - Common issues and quick solutions
ML Service Down Guide - Troubleshooting ML service issues
Debugging Blank Pages - Frontend rendering issues
Resolving Blocked Push - Git push issues resolution
App Page Rendering Fixes - Frontend page rendering fixes
Routing Fixes Summary - Routing system fixes
ML CORS Origins Fix - CORS configuration for ML service
ML Pydantic V2 Fix - Pydantic version compatibility fixes

Project Management

Project planning, status tracking, and management documentation.

GitHub Setup Complete - GitHub repository setup
GitHub Issues Complete - Issue tracking setup
Project Board Setup - Project board configuration
User Stories - Complete user story collection
Phase 1 Task Breakdown - Detailed task breakdown for Phase 1
Lease Lifecycle Upgrade Plan - Lease management upgrade plan
Maintenance Modernization Rollout - Maintenance system modernization
Tablet Implementation Summary - Tablet UI implementation

Mobile Application

Mobile app development, features, and implementation status.

Mobile App MVP Plan - Minimum viable product plan
Mobile App MVP Complete - MVP completion summary
Mobile App Phase 1 Complete - Phase 1 implementation
Mobile App Phase 2 Progress - Phase 2 development status
Mobile App Registration Complete - Registration feature
Mobile App Biometric Complete - Biometric authentication
Mobile App Profile Complete - User profile feature
Mobile App Navigation Complete - Navigation system

Quick Links

Getting Started

New to the project? Start with Backend Environment Setup and Frontend Environment Setup
Need to understand the system? Read the Comprehensive Analysis Report
Setting up for development? Check the Complete Execution Guide

For Developers

API Development: API Specifications | Frontend API Usage
Testing: Testing Overview | E2E Test Coverage
Architecture: App Architecture | ADR

For AI/ML Work

AI Features: AI Implementation Roadmap | AI Monitoring Guide
ML Service: ML Training Guide | Rent Optimization

For Troubleshooting

Common Issues: Quick Fixes
Service Issues: ML Service Down Guide
Frontend Issues: Debugging Blank Pages

For Project Management

Status Tracking: Implementation Status
User Stories: User Stories
Phase Status: Phase Completion Reports

Contributing to Documentation

Adding New Documentation

Choose the Right Category
- Architecture docs → architecture/
- Setup guides → setup/
- Implementation status → implementation/
- API docs → api/
- Testing guides → testing/
- AI/ML features → ai-ml/
- Integration guides → integrations/
- User guides → guides/
- Troubleshooting → troubleshooting/
- Project management → project-management/
- Mobile app → mobile/
Naming Conventions
- Use lowercase with hyphens: my-new-document.md
- Be descriptive: phase-2-authentication-implementation.md
- Avoid special characters and spaces
Update This README
- Add your new document to the appropriate section above
- Include a brief 1-sentence description
- Maintain alphabetical order within sections
Document Structure
- Include a clear title and date
- Add a table of contents for long documents
- Use consistent markdown formatting
- Include code examples where relevant

Documentation Standards

Clarity: Write for your audience (developers, users, stakeholders)
Completeness: Include all necessary information
Currency: Keep documentation up-to-date with code changes
Examples: Provide working code examples and use cases
Links: Link to related documentation

Document Maintenance

This documentation is actively maintained. If you find:

Outdated information
Broken links
Missing documentation
Errors or inconsistencies

Please update the relevant files or create an issue in the project repository.

Last Documentation Reorganization: November 2025
Maintained By: Development Team

Name		Name	Last commit message	Last commit date
Latest commit History 549 Commits
.cursor/plans		.cursor/plans
.devcontainer		.devcontainer
.github		.github
.husky		.husky
.vscode		.vscode
ai_prescreening_service		ai_prescreening_service
contracts/property-os/v1.6		contracts/property-os/v1.6
docs		docs
migrations/mil		migrations/mil
ops		ops
packages		packages
pms-mobile-portals		pms-mobile-portals
pms-plans		pms-plans
prisma		prisma
rent_optimization_ml		rent_optimization_ml
reports		reports
scripts		scripts
security/mil		security/mil
services		services
smart_contracts		smart_contracts
tenant_portal/v_2		tenant_portal/v_2
tenant_portal_app		tenant_portal_app
tenant_portal_backend		tenant_portal_backend
tenant_portal_mobile		tenant_portal_mobile
tools		tools
.dockerignore		.dockerignore
.gitignore		.gitignore
BRANDING_UPDATE_SUMMARY.md		BRANDING_UPDATE_SUMMARY.md
CHANGELOG.md		CHANGELOG.md
DOCS_REORG_SUMMARY.md		DOCS_REORG_SUMMARY.md
Gitbingit.exe -C CUsersplabrOneDriveDocumentsDevpms-master status -sb		Gitbingit.exe -C CUsersplabrOneDriveDocumentsDevpms-master status -sb
QuickBooks_Integration_Tests.postman_collection.json		QuickBooks_Integration_Tests.postman_collection.json
VERSION		VERSION
WIKI_SYNC.md		WIKI_SYNC.md
^C		^C
agent-policies.yaml		agent-policies.yaml
docker-compose.prod.yml		docker-compose.prod.yml
docker-compose.yml		docker-compose.yml
docs-reorganization-log.txt		docs-reorganization-log.txt
docusign_private_key.pem		docusign_private_key.pem
docusign_public_key.pem		docusign_public_key.pem
ersplabrOneDriveDocumentsDevpms-master		ersplabrOneDriveDocumentsDevpms-master
fix_env.py		fix_env.py
import re.py		import re.py
install_log.txt		install_log.txt
lint.log		lint.log
logs.txt		logs.txt
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
start-check.log		start-check.log
tsconfig.base.json		tsconfig.base.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Property Management Suite - Documentation

Executive Summary

Core Components

Key Features

Documentation Structure

Documentation Index

Architecture & Design

Setup & Installation

Implementation Status

API Documentation

Testing

AI & Machine Learning

Integrations

User Guides

Wiki Documentation

Troubleshooting

Project Management

Mobile Application

Quick Links

Getting Started

For Developers

For AI/ML Work

For Troubleshooting

For Project Management

Contributing to Documentation

Adding New Documentation

Documentation Standards

Document Maintenance

About

Uh oh!

Releases

Packages

Uh oh!

Contributors

Uh oh!

Languages

Folders and files

Latest commit

History

Repository files navigation

Property Management Suite - Documentation

Executive Summary

Core Components

Key Features

Documentation Structure

Documentation Index

Architecture & Design

Setup & Installation

Implementation Status

API Documentation

Testing

AI & Machine Learning

Integrations

User Guides

Wiki Documentation

Troubleshooting

Project Management

Mobile Application

Quick Links

Getting Started

For Developers

For AI/ML Work

For Troubleshooting

For Project Management

Contributing to Documentation

Adding New Documentation

Documentation Standards

Document Maintenance

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages