GitHub - jefftriplett/django-startproject: :checkered_flag: Django Start Project template with batteries (original) (raw)

Welcome to django-startproject 👋

Django startproject template with batteries

🚩 Core Features

Django 5.1
Python 3.13
Docker Compose
Justfile recipes
Postgres auto updates
uv support

🚩 Django Features

django-click
environs[django]
psycopg[binary]
whitenoise

👕 Linting/auto-formatting

djade
django-upgrade
djhtml
pre-commit
pyupgrade
ruff

💚 CI

django-test-plus
model-bakery
pytest
pytest-cov
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

Re-build PIP requirements

$ just lock

`just` Commands

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

🌟 Community Projects

🤝 Contributing

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

Show your support

Give a ⭐️ if this project helped you!