🧱 Backend Project Structure

This document provides an overview of the backend directory structure for the Django + Wagtail project.

---

📁 Project Layout

backend/
│
├── Dockerfile                          # Docker build instructions for production/deployment
├── manage.py                           # Django CLI: runserver, migrate, createsuperuser, etc.
├── home/                               # Main Wagtail page app
│   ├── __init__.py                     # Marks module as a Python package
│   ├── apps.py                         # Django AppConfig for "home"
│   ├── models.py                       # Wagtail Page models (HomePage, blocks, etc.)
│   ├── templates/                      # Templates owned by this app
│   │   └── home_page.html              # Template for HomePage (if not fully headless)
│   ├── static/                         # App-specific static assets
│   │   └── css/                        # CSS files for the home app
│   ├── migrations/                     # Database schema history for this app
│   │   └── 0001_initial.py             # Initial migration generated by Wagtail scaffold
│   │   └── 0002_create_homepage.py     # Migration generated by for homepage creation
│   └── tests.py                        # Unit tests for the home app
├── search/                             # Simple search app (no models)
│   ├── __init__.py                     # Marks module as a Python package
│   ├── views.py                        # Search view using Wagtail search backend
│   └── templates/                      # Templates for search results
│       └── results.html                # Template that displays search results
│   # NOTE: no migrations because search has no models
│   # NOTE: no apps.py — Django uses default AppConfig
│   # NOTE: no static/ — search app contains no assets
│
├── mysite/                             # Core Django project configuration
│   ├── __init__.py                     # Marks project module as a Python package
│   ├── settings/                       # Modular Django + Wagtail settings
│   │   ├── __init__.py                 # Makes settings importable
│   │   ├── base.py                     # Shared settings for all environments
│   │   ├── dev.py                      # DEBUG, local DB, dev middleware, etc.
│   │   └── production.py               # Security, caching, production toggles
│   ├── urls.py                         # Root URL routing (wagtail admin, API, home routes)
│   ├── wsgi.py                         # WSGI entrypoint for Gunicorn/apache
│   ├── asgi.py                         # ASGI entrypoint for Uvicorn/Daphne (async support)
│   ├── static/                         # Project-wide static files (logos, overrides, etc.)
│   └── templates/                      # Global templates (layout, shared UI)
│       └── base.html                   # Main template inherited by others (if not headless)
├── requirements.txt                    # Python dependencies for pip instalL
└── venv/                               # Optional: local virtual environment

---

📘 Overview

This structure follows typical Django best practices, including:

• Each app (e.g., home/, search/) is isolated with its own templates and migrations.
• The mysite/ folder contains global project config (settings, URLs, WSGI/ASGI).
• Dockerfile makes the backend ready for containerized deployments.
• A dedicated static/ and templates/ folder is included for project-wide front‑end assets.

---

📄 Requirements

Install dependencies:

pip install -r requirements.txt

---

▶️ Running the Project

Start the development server:

python manage.py runserver

---

🧪 Running Tests

python manage.py test

---