🏁 Django Start Project template with batteries
  • Just 53.2%
  • Dockerfile 25.3%
  • Python 18.2%
  • Shell 3.3%
Find a file
2024-03-02 15:06:58 -06:00
.github/workflows 🚜 docker-compose => compose 2024-03-01 21:16:09 -06:00
config ⬆️ Upgrades to Django 4.2 2023-04-07 15:32:55 -05:00
frontend 🎨 Updates favicons 2020-04-11 13:19:52 -05:00
.dockerignore 🚜 docker-compose => compose 2024-03-01 21:16:09 -06:00
.editorconfig 🚜 Flattens files to work via url 2020-04-10 23:49:24 -05:00
.env-dist 🚜 Updating my defaults 2024-03-02 09:49:37 -06:00
.gitignore 🐳 🚜 Refactors compose 2024-03-02 10:12:39 -06:00
.pre-commit-config.yaml ⬆️ Upgrades to Django 5.0 and Python 3.12 2024-03-01 20:57:51 -06:00
compose-entrypoint.sh 🐳 🚜 Refactors compose 2024-03-02 10:12:39 -06:00
compose.override.yml-dist 🐳 🚜 Refactors compose 2024-03-02 10:12:39 -06:00
compose.yml ⚙️ Adds healthcheck 2024-03-02 10:14:20 -06:00
conftest.py-tpl 🚜 Consolidate configs 2022-09-06 08:43:43 -05:00
Dockerfile 🚜 Updates 2024-03-01 21:11:40 -06:00
justfile 🚜 Consolidate lint commands 2024-03-02 14:59:16 -06:00
LICENSE Initial commit 2018-02-10 09:38:30 -06:00
manage.py-tpl 🚜 Flattens files to work via url 2020-04-10 23:49:24 -05:00
pyproject.toml ⬆️ Upgrades to Django 5.0 and Python 3.12 2024-03-01 20:57:51 -06:00
README.md 📝 Updates cog output 2024-03-02 15:06:58 -06:00
requirements.in 🚜 Updates 2024-03-01 21:11:40 -06:00
requirements.txt 🚜 Updates 2024-03-01 21:11:40 -06:00

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!