Tutorial: Overview

django-angular3 enables seamless integration of Django, Django REST Framework (DRF), and Angular — giving teams a contract-first, automation-ready bridge between a DRF backend and an Angular Material frontend.

For the full description see the project README.

Repository planning is organized by domain:

Prerequisites

  • Python 3.12+ with pip.

  • Node.js and pnpm — only needed once you generate or build the Angular workspace. Validation works without them.

You do not need a Django project to try the validation commands: the standalone CLI runs them directly.

1. Install the package

pip install django-angular3

Add to INSTALLED_APPS to enable the ng_* management commands:

INSTALLED_APPS = [
    ...
    "django_angular3",
]

To work from a local clone instead:

pip install -e /path/to/django-angular3/

Verify the standalone CLI is available:

django-angular3 --help

Core commands

django-admin validate-project
django-admin build_app --dry-run
django-admin ng_workspace --dry-run
django-admin ng_openapi_gen --dry-run

Tutorial navigation