Skeleton Django API

Dockerized basic REST Web API based on Django, complete with user management, using only email and password.

Installation

Run the following commands in terminal to get started

git clone https://github.com/apekatten/skeleton-django-api.git
cd skeleton-django-api
mv postgres.env-sample postgres.env
docker-compose build
docker-compose up

This will start everything and run migrations. When this is done you should stop the server using Ctrl+C and running the following to create a admin user.

docker-compose run api sh -c "python manage.py createsuperuser"

Please note that a unique username must be given while creating superuser, but is not used elsewhere. Will remove this at a later time.

You can now visit the API Docs at http://localhost:8000/docs/

Technologies

• Django
• Django REST Framework
• Allauth
• Argon2
• Travis CI
• PostgreSQL
• Docker

TODO

• Remove username completely, now it is just hidden
• Add example API app
• Test for timing attacks
• Add throttling to login
• Audit logging
• Max login attempts for Django Admin
• Change email templates
• Fix email verification (https://django-rest-auth.readthedocs.io/en/latest/faq.html)
• Create setup command to replace secrets
• Fix documentation

Commands

• Run unit tests and linting
  • docker-compose run api sh -c "python manage.py test && flake8"
• Create new app
  • docker-compose run api sh -c "python manage.py startapp appname"
• Make migrations for model changes
  • docker-compose run api sh -c "python manage.py makemigrations"

Inspiration

• https://wsvincent.com/django-rest-framework-user-authentication-tutorial/