Orange County Lettings

Purpose-built Django application for listing rentals and browsing user profiles. This documentation guides external contributors and operators through setup, development, testing, and deployment.

Overview

• Project type: Django 5 application

• Apps: lettings, profiles

• Persistent store: SQLite (development), file-based via Docker bind mount (local runs)

• Static files: served by WhiteNoise in production

Audience

• Developers integrating or contributing to the codebase

• Operators deploying and running the service

Quick start

Start with Start Here, then follow Orange County Lettings - Getting Started for local setup. For day-to-day commands and workflows, see Development.

Contents

Topics

• Start Here
  • Who this is for
  • What you will do
  • Prerequisites
  • Next steps
• Development
  • Run the application
  • Run tests and coverage
  • Linting and code style
  • Database and migrations
  • Static files
  • Build and view documentation (Sphinx)
  • Additional guides
• Deployment & Ops
  • Orange County Lettings - Docker
  • Orange County Lettings - CI/CD
  • Orange County Lettings - Sentry
• API Reference
  • Modules overview
• Reference
  • Orange County Lettings — Architecture
  • Orange County Lettings — Models
  • Orange County Lettings - Views
  • Orange County Lettings - Error Pages
• Project Documentation