Welcome to django-startproject 👋

Django startproject template with batteries

:triangular_flag_on_post: Features

• Django 5.0
• Python 3.12
• Docker Compose
• uv
• django-click
• environs[django]
• psycopg2-binary
• whitenoise

:shirt: Linting/auto-formatting

• django-upgrade
• djhtml
• pre-commit
• pyupgrade
• ruff

:green_heart: CI

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

🏠 Homepage

:wrench: Install

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

:rocket: 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

# Re-build PIP requirements
$ just lock

just Commands

$ just --list

Available recipes:
    bootstrap *ARGS
    build *ARGS
    console
    down *ARGS
    lint *ARGS
    lock *ARGS
    logs *ARGS
    manage *ARGS
    pg_dump file='db.dump'    # dump database to file
    pg_restore file='db.dump' # restore database dump from file
    restart *ARGS
    run *ARGS
    start *ARGS="--detach"
    stop *ARGS
    tail
    test *ARGS
    up *ARGS
    upgrade

Author

👤 Jeff Triplett

• Website: https://jefftriplett.com
• Mastodon: @[email protected]
• Xwitter: @webology
• GitHub: @jefftriplett

🤝 Contributing

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

Show your support

Give a ⭐️ if this project helped you!