How samanthasgroup/django-webapps works
Project type and purpose
• This is a Django-based backend service (“django-webapps”) that exposes a REST API (via Django REST Framework), provides a Django Admin UI, and uses Celery for asynchronous jobs. There is no user-facing SPA—clients (e.g., web UIs, scripts, mobile apps) talk to the API endpoints.
File structure
• Top-level directories:
• api/ ← the main Django “api” app (models, serializers, views, filters, processors, management commands, migrations)
• django_webapps/ ← project settings (ASGI/WSGI, URL routing, settings.py)
• celery_config/ ← Celery app and tasks
• templates/ ← admin override templates
• static/ ← admin static assets
• tests/ ← pytest configuration and test suites (unit + API tests)
• docker-compose.yml & .override ← Docker definitions for Postgres + Redis + Django
• Key files: manage.py, pyproject.toml, Makefile, .env.sample, Docker Compose, migrations, management commands, Celery tasks, scripts for data population.
Extract insights from the README
• Exposes API docs at /docs/swagger and /docs/redoc.
• Uses UV CLI to run manage.py commands.
• Docker Compose brings up PostgreSQL (production DB) and Redis (Celery broker/cache).
• Default local DB is SQLite (for dev).
• Relies on JSONField in some models.
• No custom frontend beyond Django Admin.
Elements
• Clear labels for each component (e.g., “Django REST API,” “Celery Worker,” “PostgreSQL DB,” “Redis Broker”).
• Web components (Django, Swagger) in blue
• Data stores (PostgreSQL, Redis) in green
• Async/worker components (Celery) in orange
• Scripts/management commands in gray
Detail without over-splitting
• Migrations/management under “Admin & Maintenance” rather than listing each command.
• Essential architectural elements: API server, DB, cache/broker, workers, scripts, docs, clients.