How-to Guides

This section contains practical, step-by-step guides for accomplishing specific tasks with the Real Estate Investor application.

Property Management

• Add a New Property — Create and configure a property for analysis
• Update Property Information — Modify existing property details
• Import Bulk Property Data — Load multiple properties from CSV files

Financial Analysis

• Calculate Investment Metrics — Compute NOI, Cap Rate, Cash-on-Cash, IRR, and DSCR
• Update Rental Income — Modify rent amounts and vacancy rates
• Manage Operating Expenses — Add, update, or remove property expenses
• Track Property Transactions — Record purchases, loans, and capital expenditures

Development

• Set Up Local Development Environment — Configure your development workspace
• Run Tests — Execute unit, integration, and BDD tests
• Run Linters and Type Checkers — Ensure code quality with ruff, black, and mypy
• Work with Docker Compose — Use containerized development environment

Database Operations

• Switch Between SQLite and PostgreSQL — Configure database backends
• Run Database Migrations — Apply schema changes
• Create Database Backups — Protect your data

Deployment

• Deploy with Docker — Production deployment using Docker
• Configure Environment Variables — Set up production configuration
• Collect Static Files — Prepare static assets for production

Browse All Guides

• Add a New Property
• Calculate Investment Metrics
• Code Quality Tools
• Configure Environment Variables
• Database Setup
• Deploy with Docker
• Import Bulk Data
• Manage Operating Expenses
• Run Database Migrations
• Run Tests
• Set Up Local Development
• Track Transactions
• Update Property Information
• Update Rental Income
• Work with Docker Compose