Welcome to django-startproject 👋

Django startproject template with batteries

Note

Modern Django Development Stack 🚀

This is a production-ready Django project template featuring the latest Python 3.14, Django 6.0, and modern tooling including uv for blazing-fast dependency management, Docker Compose for containerization, and Justfile for streamlined commands. Perfect for starting new projects or learning best practices with batteries included!

🚩 Core Features

• Django 6.0
• Python 3.14
• Docker Compose (I prefer Orbstack)
• Justfile recipes
• Postgres auto updates
• uv support
• pre-commit support via prek

🚩 Django Features

• django-click
• django-prodserver[gunicorn]
• environs[django]
• psycopg[binary]
• whitenoise

👕 Linting/auto-formatting

• pre-commit (using prek)
  • check-pre-commit-ci-config (validate the pre-commit.ci config)
  • Standard hooks (check-added-large-files, check-case-conflict, check-json, check-merge-conflict, check-symlinks, check-toml, check-yaml, end-of-file-fixer, trailing-whitespace)
  • uv-lock (keep uv.lock in sync with pyproject.toml)
  • ruff (linting and formatting)
  • dclint (Docker Compose linting)
  • pyupgrade (Python 3.14+)
  • django-upgrade (Django 5.0+)
  • djade (Django template formatting; target version auto-detected from pyproject.toml)
  • djhtml / djcss / djjs (Django template, CSS, and JS formatting)
  • rustywind (sort Tailwind CSS classes)
  • pretty-format-toml (format TOML files)

💚 CI

• django-test-plus
• model-bakery
• pytest
• pytest-django

🏠 Homepage

🔧 Install

$ uv run --with=django django-admin startproject \
    --extension=ini,py,toml,yaml,yml \
    --template=https://github.com/jefftriplett/django-startproject/archive/main.zip \
    example_project

$ cd example_project

$ just bootstrap

🚀 Usage

# Bootstrap our project
$ just bootstrap

# Build our Docker Image
$ just build

# Run Migrations
$ just manage migrate

# Create a Superuser in Django
$ just manage createsuperuser

# Run Django on http://localhost:8000/
$ just up

# Run Django in background mode
$ just start

# Stop all running containers
$ just down

# Open a bash shell/console
$ just console

# Run Tests
$ just test

# Lint the project / run pre-commit by hand
$ just lint

# Lock dependencies with uv
$ just lock

just Commands

$ just --list

Available recipes:
    bootstrap *ARGS           # Initialize project with dependencies and environment
    build *ARGS               # Build Docker containers with optional args
    console                   # Open interactive bash console in utility container
    down *ARGS                # Stop and remove containers, networks
    lint *ARGS                # Run pre-commit hooks on all files
    lint-autoupdate *ARGS     # Update pre-commit hooks to latest versions
    lock *ARGS                # Lock dependencies with uv
    logs *ARGS                # Show logs from containers
    manage *ARGS              # Run Django management commands
    pg_dump file='db.dump'    # Dump database to file
    pg_restore file='db.dump' # Restore database dump from file
    restart *ARGS             # Restart containers
    run *ARGS                 # Run command in utility container
    start *ARGS="--detach"    # Start services in detached mode by default
    stop *ARGS                # Stop services (alias for down)
    tail                      # Show and follow logs
    test *ARGS                # Run pytest with arguments
    up *ARGS                  # Start containers
    upgrade                   # Upgrade dependencies and lock

Author

👤 Jeff Triplett

• Website: https://jefftriplett.com
• Micro Blog: https://micro.webology.dev
• Mastodon: @[email protected]
• Xwitter: @webology
• GitHub: @jefftriplett
• Hire me: revsys

🌟 Community Projects

• Django News Newsletter
• Django News Jobs
• Django Packages
• DjangoCon US
• Awesome Django

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!