Tutorial

This tutorial builds a djcrud application from the ground up. Each chapter is a Django app in djcrud_example; source files are included literally and validated by pytest -m tutorial.

  • routing — default HTML CRUD (routing_example)

  • views — custom HTML views, object actions, list actions, site search (views_example, action_example, listaction_example, search_example)

  • permission — row and action rules (security_example)

  • drf — DRF API and OpenAPI (drf_example)

  • spa — SPA shell and client codegen (spa_example)

  • agents — MCP tools over the DRF API (mcp_example/djcrud.py)

Optional packages (djcrud_history, djcrud_debug, …) are covered in Install djcrud — they work as soon as you add them to INSTALLED_APPS.