/django-startproject

:checkered_flag: Django Start Project template with batteries

Primary LanguageJustBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Welcome to django-startproject 👋

CI

Django startproject template with batteries

🚩 Features

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

💚 CI

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

🏠 Homepage

🔧 Install

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

🚀 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
    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
    tail
    test *ARGS
    up *ARGS
    upgrade

Author

👤 Jeff Triplett

🤝 Contributing

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

Show your support

Give a ⭐️ if this project helped you!