oryon-dominik / django-template

Project And App Structure for Django

django-template

Project And App Structure Templates for Django.

---

You can use these templates by referring to their release files during project/app creation.
Preinstalled Django in your local python version is required.
Although this should be pretty self-explanatory, please remember to replace <project_name> and <app_name> with your project/app name ;-) and (of course, dear mrkf 😎) git initialize it.

Projects

Django Project

django-admin startproject --template https://github.com/oryon-dominik/django-template/releases/download/latest/project_template_django.zip --extension=py,md,toml,yaml,yml,env,service,conf,sql. <project_name> <directory>

Local python version:

python -c 'import os;import sys;from pathlib import Path;os.system(str((Path(sys.executable).parent / \"Scripts\" / \"django-admin\").resolve()) + \" startproject --template https://github.com/oryon-dominik/django-template/releases/download/latest/project_template_django.zip --extension=py,md,toml,yaml,yml,env,service,conf,sql,sh. <project_name> .\")'

For any subsequent command (creating apps..) install the dependencies (poetry install) and activate your virtual environment.

CLI Project

django-admin startproject --template https://github.com/oryon-dominik/django-template/releases/download/latest/project_template_cli.zip --extension=py,md,toml,yaml,yml,env,service,conf,sql,sh. <project_name> <directory>

Django Apps

Default App

(will be created in the project's apps folder)

python manage.py startapp --template https://github.com/oryon-dominik/django-template/releases/download/latest/app_template_default.zip --extension=py,md,toml,yaml,yml,env,service,conf,sql,sh. <app_name>

• Add 'apps.<app_name>.apps.<app_name.capitalize()>Config' to LOCAL_APPS or PROJECT_APPS in config.settings.base.apps.py.
• Add the apps routes to urlpatterns in config.urls.routes.py like this: path('', include('apps.<app_name>.urls', namespace="<app_name>")),.

Rest App

(will be created in the project's apps folder)

python manage.py startapp --template https://github.com/oryon-dominik/django-template/releases/download/latest/app_template_rest.zip --extension=py,md,toml,yaml,yml,env,service,conf,sql,sh. <app_name>

• Add 'apps.<app_name>.apps.<app_name.capitalize()>Config' to LOCAL_APPS or PROJECT_APPS in config.settings.base.apps.py.
• Add the apps routes to urlpatterns in config.urls.routes.py like this: path('', include('apps.<app_name>.api.urls', namespace="<app_name>")),.

Authentication App for JWT

(will be created in the project's apps folder)

python manage.py startapp --template https://github.com/oryon-dominik/django-template/releases/download/latest/app_template_authentication.zip --extension=py,md,toml,yaml,yml,env,service,conf,sql,sh. authentication

• In config.urls.apis.py comment path('', include('apps.authentication.api.urls')), in.

Authentication is checking blacklisted tokens (whitelisting is a BAD idea ;-P) and will have a slow default cache (database access) for production. If you only use one worker, you might want to switch to memory for development.

# for a database cache backend create the table
python manage.py createcachetable

Basic CRUD Templates Example App

(will be created in the project's apps folder, please use a singluar name, that will be automatically pluralized - it's a crud app after all ;-] )

python manage.py startapp --template https://github.com/oryon-dominik/django-template/releases/download/latest/app_template_simple_crud_templates.zip --extension=py,md,toml,yaml,yml,env,service,conf,sql,sh. --pluralize-name --replace-html <app_name>

• Add 'apps.<app_name>.apps.<app_name.capitalize()>Config' to LOCAL_APPS or PROJECT_APPS in config.settings.base.apps.py.
• Add the apps routes to urlpatterns in config.urls.routes.py like this: path('', include('apps.<app_name>.api.urls', namespace="<app_name>")),.
• Edit your models.py accordingly and makemigrations and migrate.

Basic vuejs Templates Example App

(will be created in the project's apps folder, please use a singluar name)

python manage.py startapp --template https://github.com/oryon-dominik/django-template/releases/download/latest/app_template_vuejs_templates.zip --extension=py,md,toml,yaml,yml,env,service,conf,sql,sh. --replace-html <app_name>

• Add 'apps.<app_name>.apps.<app_name.capitalize()>Config' to LOCAL_APPS or PROJECT_APPS in config.settings.base.apps.py.

• Comment-In 'django_vite', in THIRD_PARTY_APPS of config.settings.base.apps.py.

• In your pyproject.toml set [tool.poetry.group.vite][optional] = false and poetry install the dependeciey django-vite.

• Add the apps routes to urlpatterns in config.urls.routes.py like this: path('', include('apps.<app_name>.urls', namespace="<app_name>")),.

• Create a frontend in ./frontend, compiling to ./frontend/dist.

• You might clone the vuejs-template for a quick start.

  git clone https://github.com/oryon-dominik/skeleton-vuejs-djangoexample/ ./frontend

Custom User (Accounts) App

(will be created in the project's apps folder)
TODOs: after setting up the template:

• Comment out "core.accounts" in CORE_APPS in config.settings.base.apps.py (Line 14).
• Comment in "apps.accounts.apps.AccountsConfig", in LOCAL_APPS in config.settings.base.apps.py (Line 26).
• Comment in the apps routes to urlpatterns in config.urls.routes.py (line 42)
• Delete the __init__.py in core/accounts/migrations/ and run python manage.py migrate.

python manage.py startapp --template https://github.com/oryon-dominik/django-template/releases/download/latest/app_template_accounts.zip --extension=py,md,toml,yaml,yml,env,service,conf,sql. --replace-html accounts

Caveats

The .pre-commit-config.yaml mypy hook needs a lot of dependencies, so you might want to clean it up a bit if your just using the minimal template.

Credits

<3 shezi