django-starter-cdc

Generate a new Django 6.1 project from django-starter: either a full-stack app (Django templates, HTMX, Alpine.js, Tailwind) or an API-only backend (Django REST Framework + allauth headless).

The generator has no dependencies of its own. It needs Python 3.14 or newer: on an older Python, pip stops with "requires a different Python". The projects it creates are managed with uv (plus npm for the full variant), so install uv however you install the generator.

Install

With uv (recommended). uvx runs the generator in a throwaway environment, so there is nothing to install or upgrade, and uv fetches Python 3.14 for you if needed:

uvx django-starter-cdc new myproject

With pip and a virtual environment. Following the Python Packaging User Guide, create and activate a virtual environment with Python 3.14, then install the package into it:

python3.14 -m venv .venv
source .venv/bin/activate          # Windows: .venv\Scripts\activate
python -m pip install --upgrade pip
python -m pip install django-starter-cdc
django-starter-cdc --version

Run deactivate when you're done. python -m django_starter_cdc works too, in place of the django-starter-cdc command. To upgrade later, run python -m pip install --upgrade django-starter-cdc.

With pipx, to keep the command available everywhere without managing a virtual environment yourself:

pipx install --python python3.14 django-starter-cdc

Usage

django-starter-cdc new myproject          # full variant
django-starter-cdc new myproject --api    # API-only variant

(With uv, prefix these with uvx.)

This downloads the django-starter release that matches the generator's version, renders the chosen variant into ./myproject, writes a .env with a fresh SECRET_KEY, runs git init and then make init (installs dependencies and migrates the SQLite database). Then:

cd myproject
make start

and open http://localhost:8000/admin/ and http://localhost:8000/api/schema/swagger-ui/.

Options

django-starter-cdc new <name> [--api] [--email EMAIL] [--ref REF | --source PATH]
                              [--no-install] [--no-git] [--dir PATH]

The target directory must not exist or must be empty. If make, uv or (for the full variant) npm is not installed, the generator skips make init and prints the equivalent steps: uv sync, npm install && npm run build (full only) and uv run python manage.py migrate.

Variants

Both variants share the same core: Django 6.1 on Python 3.14, a custom user model, django-allauth with headless mode, Django REST Framework with a drf-spectacular OpenAPI schema, Django's built-in tasks framework, SQLite for local development and a Docker Compose stack (Postgres + Redis + gunicorn) for production.

Full (default) adds the server-rendered web app: Django templates, HTMX and Alpine.js for interactivity, Tailwind CSS 4 built with the Tailwind CLI (no JavaScript bundler), allauth's account pages, a profile page, sitemaps and meta tags.

API-only (--api) has no templates (other than the allauth email templates), no front-end assets and no npm. allauth runs with HEADLESS_ONLY = True, so authentication is a JSON API meant for a separate front end or mobile app.

Authentication API

allauth headless serves its auth API under /_allauth/. Mobile and other non-browser clients use the app client, which authenticates with a session token instead of cookies:

A successful signup or login returns meta.session_token. Send it as the X-Session-Token header on later requests, both to the allauth endpoints and to your own API views:

curl -s -X POST http://localhost:8000/_allauth/app/v1/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"email": "you@example.com", "password": "..."}'

curl -s http://localhost:8000/api/users/me/ -H 'X-Session-Token: <session_token>'

GET /api/users/me/ is the sample DRF endpoint: it returns the logged-in user. While DEBUG is on, the full allauth API reference is served at http://localhost:8000/_allauth/openapi.html, and your own DRF endpoints are documented at http://localhost:8000/api/schema/swagger-ui/.

Browser front ends can use the browser client (/_allauth/browser/v1/...), which uses Django's session cookie and CSRF token. A browser SPA served from another origin (for example a Vite dev server on port 5173) will also want django-cors-headers to allow its origin.

License

MIT