Update project README

[Aurelien7777]

Update Readme

Summary by Sourcery

Revise the project README to provide a comprehensive overview of the OC Lettings application and its workflow.

Documentation:

• Expand README with project description, key features, technologies, and architecture overview.
• Add detailed instructions for local installation, configuration, testing, and administration.
• Document Docker usage, CI/CD pipeline behavior, Sentry error monitoring, and Sphinx/Read the Docs documentation setup.

[sourcery-ai]

Reviewer's Guide

README is rewritten to provide a full product-level overview of OC Lettings, including architecture, local setup, Docker usage, CI/CD pipeline, Sentry monitoring, and documentation, replacing the previous, much shorter local-dev focused doc.

Flow diagram for the GitHub Actions CI/CD pipeline

flowchart LR
  push_master[Push to master]
  tests[Run Django tests with coverage]
  coverage_check[Check coverage >= 80%]
  lint[Run flake8]
  build_image[Build Docker image]
  push_docker[Push image to Docker Hub]
  trigger_render[Trigger Render deployment]

  push_master --> tests --> coverage_check --> lint --> build_image --> push_docker --> trigger_render

Loading

File-Level Changes

Change	Details	Files
Replace minimal French résumé with a full project introduction and high-level description of the refactored, containerized Django application.	Rename top-level heading to 'OC Lettings' and describe the app and its refactor from monolith to modular architecture with CI/CD. Add links section with production URL, documentation, and GitHub repository.	README.md
Document core functionality, technologies, and internal architecture of the project.	List user-facing features like listings and profiles, admin interface, custom error pages, and Sentry-based monitoring. List main technologies (Python/Django, SQLite, Gunicorn, WhiteNoise, Docker, GitHub Actions, Render, Sentry, Sphinx, etc.). Describe the modular architecture and roles of oc_lettings_site, lettings, and profiles components.	README.md
Replace old, OS-specific local dev instructions with a structured, cross-platform local installation and run guide.	Specify prerequisites (Git, Python 3.7, pip, venv) and add explicit clone instructions for this repository. Add detailed virtualenv creation/activation commands for Windows and macOS/Linux. Add steps to install dependencies, configure .env with key settings including optional Sentry DSN, run migrations, and start the server. Remove legacy instructions for SQLite CLI usage, admin credentials, and OS-specific Python/pip checks that are no longer needed.	README.md
Add sections on administration, testing, linting, Docker usage, and CI/CD workflow.	Document admin superuser creation and access to Django admin. Describe running tests with coverage and enforcing an 80% threshold, plus flake8 linting commands. Add Docker build and run commands, including environment variables and port mapping, and link to production Docker Hub image. Explain the GitHub Actions pipeline steps from tests to Docker image build/push and deployment to Render.	README.md
Introduce monitoring and documentation sections describing Sentry configuration and Sphinx/Read the Docs usage.	Explain key Sentry configuration variables and privacy-related option send_default_pii being disabled. Add instructions for building the Sphinx documentation locally and where to find generated HTML. Link to the hosted technical documentation on Read the Docs.	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}