README.md

Django template

An opinionated template for quickly bootstrapping a django project using postgres, docker and nginx.

Features

• Everything Django offers OOTB
• CORS support
• Autogenerated OpenAPI and ReDoc API documentation
• Production deployment using docker-compose
• SSL using Nginx and LetsEncrypt

Instructions to run

Pre-requisites:

• Python 3.7 and above
• Poetry
• Docker
• docker-compose

Installing dependencies

poetry shell # sets up and activates a venv
poetry install # installs missing dependencies from the lockfile

Run migrations

python manage.py makemigrations
python manage.py migrate

Start the server

In debug

python manage.py runserver

In production

docker-compose up -d --build

More info

This template comes with an already existing model. Feel free to modify or remove it.

API docs can be found at:

• http://localhost:8000/docs (OpenAPI 3)
• http://localhost:8000/redoc (ReDoc)