Skip to content

Alurith/django-cookiecutter

Repository files navigation

Django cookiecutter template

Cookiecutter template for Django using Postgres, htmx and Tailwindcss.

The Stack:

PACKAGE VERSION
Python 3.8
Django 4.0.4
Postgres latest
htmx 1.7.0
Tailwindcss 3.0

How to use

Install the latest Cookiecutter:

pip install cookiecutter

Generate a new Project:

cookiecutter https://github.com/Alurith/django-cookiecutter.git

Create the .env file (update with your own values):

# postgres variables for docker
POSTGRES_DB = database_name
POSTGRES_USER = user
POSTGRES_PASSWORD = password
POSTGRES_ROOT_PASSWORD = rootpassword

# database url for dj-database-url
DATABASE_URL = postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_DB}

# DJANGO
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
# NOTICE: this key is generated by cookiecutter.
SECRET_KEY="my-really-secret-secret_key" 

Run the project with docker:

docker-compose up 

Done!

Update Philosophy

The stability of this stack is the main focus, so we will do any upgrade only in case of vulnerabilities or if some package has some interesting new features. The main branch will always host the latest version. Also, each version will have its tag and changelog.

Issues & Pull Request

Please describe your issue as clear as possible, so I can replicate the issue. Also, if you already worked on a fix you can submit a pull request.