Skip to content

index.md

Latest commit

 

History

History
178 lines (130 loc) · 7.75 KB

index.md

File metadata and controls

178 lines (130 loc) · 7.75 KB

PropManager Documentation

Welcome to the PropManager documentation! This guide covers everything you need to know about using, configuring, and developing PropManager.

Quick Links

I want to... Go to...
Quick orientation (AI/Developers) WARP.md
Set up PropManager locally Getting Started
Deploy to production Deployment Guide
Deploy with Docker Docker Production
Learn the admin portal Admin Guide
Use the tenant portal Tenant Guide
Fix an issue Troubleshooting
Contribute code Contributing

Documentation Overview

AI/Developer Quick Start

NEW: For AI assistants (Claude, GPT, etc.) and developers new to the project, start with WARP.md. This comprehensive context file provides:

  • Quick project orientation
  • Architecture overview
  • Common patterns and conventions
  • Key file locations
  • Docker deployment guides
  • Troubleshooting quick reference

User Guides

Guides for using PropManager portals.

Guide Description
Admin Guide Complete guide to the admin portal - properties, tenants, leases, billing, and more
Tenant Guide How tenants use the portal - payments, work orders, documents
Tenant Management Managing tenants - detail modal, archive/restore, deletion with safeguards
Lease Documents Linking and managing documents with leases - upload, link, auto-linking
Onboarding Guide New tenant onboarding workflow - from lease creation to move-in
Contractor Guide Token-based access for contractors to view and update work orders

Technical Documentation

Architecture and configuration details.

Document Description
Architecture System design, data models, authentication flows
Services Payment gateways, SMS, email, weather API integrations
Deployment Production setup with Nginx, SSL, and systemd

Developer Resources

For those contributing to or customizing PropManager.

Document Description
Getting Started Local development environment setup
Workflow Git branching, commits, pull requests
Background Tasks Django-Q2 task architecture and creation

Reference

Detailed technical reference material.

Document Description
API Reference URL endpoints and view documentation
Management Commands Custom Django management commands
Troubleshooting Common issues and solutions

Feature Overview

Core Features

  • Multi-Property Management - Manage multiple properties and units from one dashboard
  • Tenant Portal - Self-service portal for tenants with OTP authentication
  • Tenant Management - Complete tenant lifecycle with archive/restore, detail modal, and safe deletion
  • Lease Management - Full lease lifecycle with electronic signatures and document linking
  • Lease Documents - Upload and link documents to leases with automatic onboarding integration
  • Billing System - Automated invoicing with configurable late fees
  • Payment Processing - 7 payment gateway integrations
  • Tenant Onboarding - Automated wizard for new tenant setup with 15 configurable presets
  • eDocuments - Template-based electronic document signing with variable substitution
  • Global Search - Unified search across apps, tenants, properties, documents, and more

Payment Gateways

Gateway Payment Types
Stripe Credit/debit cards
PayPal PayPal wallet
Square Cards, in-person
Authorize.Net Credit card processing
Braintree Cards, PayPal
Plaid ACH Bank transfers
Bitcoin Cryptocurrency

Additional Features

  • Work Orders - Maintenance request system with contractor access
  • Rewards Program - Streak and prepayment incentives
  • Weather Notifications - Automated severe weather alerts
  • Document Management - Lease storage, signed documents, and automatic onboarding document integration
  • Multi-Channel Notifications - Email, SMS, in-app, webhooks
  • AWS-Style Navigation - App launcher with search, pinned apps, and recent history
  • Onboarding Presets - 15 pre-configured templates (standard, corporate, military, student, etc.)
  • Tenant Archive/Restore - Soft-delete tenants without data loss for compliance and reporting

Architecture Overview

┌─────────────────────────────────────────────────────────────┐
│                      PropManager                             │
├─────────────────┬───────────────────┬───────────────────────┤
│  Admin Portal   │   Tenant Portal   │   Contractor Access   │
│  (Staff/Mgmt)   │   (Residents)     │   (Token-based)       │
├─────────────────┴───────────────────┴───────────────────────┤
│                     Django Application                       │
├──────────┬──────────┬──────────┬──────────┬─────────────────┤
│ Accounts │ Leases   │ Billing  │  Work    │   Documents     │
│Properties│ Lifecycle│ Rewards  │  Orders  │ Communications  │
├──────────┴──────────┴──────────┴──────────┴─────────────────┤
│                     Django-Q2 Task Queue                     │
├─────────────────────────────────────────────────────────────┤
│  PostgreSQL       │     Redis        │   File Storage       │
│  (Database)       │   (Cache/Queue)  │   (Documents)        │
└───────────────────┴──────────────────┴──────────────────────┘

For detailed architecture information, see Architecture.

Getting Help

For Users

For Developers

Security Issues

For security vulnerabilities, see SECURITY.md for responsible disclosure.

Version Information

  • Current Version: 1.0.0
  • Django: 5.x
  • Python: 3.11+
  • Database: PostgreSQL 14+

See CHANGELOG.md for version history.

License

PropManager is licensed under AGPL-3.0. See LICENSE for details.

For dual-licensing inquiries, contact the maintainers.