Start Here

Read this first to get oriented before installing and running the project.

Who this is for

• New contributors who want a high-level overview

• Reviewers and operators who need to understand capabilities quickly

What you will do

• Review prerequisites and environment variables

• Prepare your local environment

• Follow the step-by-step setup guide

Prerequisites

See Orange County Lettings - Getting Started for tooling and installation steps (Git, Python, SQLite).

Next steps

Use the links below to continue.

• Configuration
  • How configuration is loaded
  • Required environment variables
  • Using a .env file
  • Generating secrets
  • Secret key stability and data access
  • Deployment notes
• Orange County Lettings - Getting Started
  • Prerequisites
  • Clone the repository
  • Create and activate a virtual environment
  • Confirm environment is active
  • Install dependencies
  • Environment configuration
  • Generate strong secrets with Clinkey (optional)
  • Run database migrations
  • Run the development server
  • Static files
  • Common issues