Reference Documentation

This section provides technical reference material for the Real Estate Investor application, including data models, API specifications, configuration options, and financial calculations.

Data Models

• Property Model — Property entity and attributes
• Rental Income Model — Rental income tracking
• Operating Expense Model — Property expense management
• Transaction Model — Financial transaction records
• Investment Analysis Model — Calculated KPI storage

Financial Calculations

• Financial KPIs Reference — Detailed explanation of all financial metrics
• NOI Calculation — Net Operating Income
• Cap Rate Calculation — Capitalization Rate
• Cash-on-Cash Return — Annual cash return
• IRR Calculation — Internal Rate of Return
• DSCR Calculation — Debt Service Coverage Ratio

API Reference

• Django Admin Interface — Using the built-in admin
• REST API Endpoints — HTTP API reference (if implemented)
• Management Commands — CLI commands

Configuration

• Environment Variables — Configuration options
• Database Settings — Database configuration
• Financial Defaults — Default rates and assumptions
• Static Files — Static asset management

Testing

• Test Structure — Test organization and conventions
• Test Fixtures — Shared test data and utilities
• Test Configuration — pytest and Django test settings

CI/CD

• CI Configuration — GitHub Actions workflows
• DORA Metrics — Deployment and quality metrics logging

Dependencies

• Python Dependencies — Required Python packages
• Database Requirements — PostgreSQL and SQLite support
• Development Tools — Linting, formatting, and type checking tools