Home

Awesome

<h1 align="center">Welcome to django-startproject 👋</h1> <p> <a href="https://github.com/jefftriplett/django-startproject/actions" target="_blank"> <img alt="CI" src="https://github.com/jefftriplett/django-startproject/workflows/CI/badge.svg" /> </a> </p>

Django startproject template with batteries

:triangular_flag_on_post: Core Features

:triangular_flag_on_post: Django Features

:shirt: Linting/auto-formatting

:green_heart: CI

🏠 Homepage

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

: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

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

# Re-build PIP requirements
$ just lock

just Commands

$ just --list
<!-- [[[cog import subprocess import cog list = subprocess.run(['just', '--list'], stdout=subprocess.PIPE) cog.out( f"```\n{list.stdout.decode('utf-8')}```" ) ]]] --> 
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
<!-- [[[end]]] -->

Author

👤 Jeff Triplett

🌟 Community Projects

🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!