README.md

Django JSON API CookieCutter template

This cookie cutter provides a Django project with JSON API support. It combines Adfinis best practices in terms of setup, structure and configuration.

Requirements

• Python ^3.9
• Latest CookieCutter
• Docker

Usage

To use, simply run cookiecutter https://github.com/adfinis/cookiecutter-django-json-api

Included in this template

Django specific:

• Django - usually last LTS release
• Django REST Framework
• Django REST Framework JSON API
• Django Filter
• mozilla_django_oidc
• Django Environ

Code quality and formatting tools:

• ruff
• Pytest
• Pytest Coverage Plugin - coverage set to 100%
• Pytest Django Plugin

Per default postgres is configured and a docker compose file provided. To support other database only DATABASE_ENGINE environment variable needs to be changed.

License

Code released under the BSD-3 Clause.