kevinbowen777 / django-api-todo

A demo of Django functionality using DRF

django-api-todo

• A basic to-do/task application & API built with Django 4.1 & Django REST Framework (DRF) 3.13 with a React frontend

Mirror repository

Table of Contents

• Features
• Installation
• Testing
• Application Demo
• Screenshots
• Reporting Bugs

---

Features

• Application
  • Browseable Web API
  • SwaggerUI & ReDoc API documentation
  • User registration with email verification & social(GitHub) login
  • Bootstrap4 & crispy-forms decorations
  • Customizable user profile pages with bio, profile pic, & country flags
• Dev/testing
  • Basic module testing templates
  • Coverage reports
  • Debug-toolbar available
  • Examples of using Factories & pytest fixtures in account app testing
  • shell_plus with IPython via django-extensions package
  • Nox testing sessions for latest Python 3.9, 3.10, and 3.11
    • black
    • Sphinx documentaion generation
    • linting
      • flake8
      • flake8-bugbear
      • flake8-import-order
    • safety(python package vulnerability testing)
    • pytest sessions with coverage
  • For additional links to package resources used in this repository, see the Package Index

Installation

• git clone https://github.com/kevinbowen777/django-api-todo.git
• cd django-api-todo/backend
• Local installation
  • poetry shell
  • poetry install
  • Django backend
    • python migrate.py migrate
    • python migrate.py createsuperuser
    • python manage.py runserver
  • React frontend
    • cd frontend
    • npm start
• Docker installation
  • docker-compose up --build
  • docker-compose exec backend python backend/manage.py migrate
• URLs:
  • http://127.0.0.1:8000/api
  • http://127.0.0.1:8000/admin
  • http://127.0.0.1:3000/ (React frontend)

---

Testing

• coverage run -m pytest
• Nox (includes sessions for black, lint, safety, tests)
  • testing supported for Python 3.9, 3.10, 3.11
  • e.g. nox, nox -rs lint-3.11, nox -s tests

---

Application Demo

A live application demonstration (Frontend hosted at Netlify, backend at PythonAnywhere)

• django-api-todo

---

Screenshots

Home

Reporting Bugs

Visit the Issues page to view currently open bug reports or open a new issue.

django-api-todo's Issues

Remove duplicate pyproject.toml dependency

Create Dockerfile & docker-compose files

Add pip-check & pip-audit to dev dependencies

Upgrade to Safety v2.0.0

Add age field to UserUpdateView & user_detail template

Update README install instructions

Add nox for testing

Install shell_plus

Add project badges to README.md

Move pre-commit dependencies to Poetry

Update SECRET_KEY generation method in env

Migrate to Poetry

Deploy to Heroku

Upgrade Docker to latest Python & Postgresql

Migrate code to new repository

Update .python-version & run Nox tests

Set up Nox for 3.11 testing

Test OAuth(social) login with SendGrid

Update pre-commit yaml with new exclusions

Add login/password to user pages

Add env template

Add pyenv version for 3.8, 3.9 testing

Add pagination to output

Update project issue labels

Move flake8 configs to .flake8 file

Configure local/dev Site ID display name to {repo_name}-dev

CSS styling: Remove bullets from navbar

Standardize block title in base template

Migrate to poetry shell. Remove manual virtualenv

Redirect homepage to api

Add custom error pages

Break tests into separate model, form, view modules

Add « & » "arrows" to Prev & Next pagination buttons

Reduce redundancy in views

We essentially repeat the queryset and serializer_class for each view, even
though the generic view extended is different. Take a look at how viewsets
and routers address this issue and allow us to create the same API views
and URLs with much less code.

ref: backend/todos/views.py

Migrate db to postgres

Upgrade to Django 4.1

Update .python-version to 3.11.0b5 for Nox testing

Upgrade to Django 4.0.6

Upgrade to Django 4.0.5

Install pre-commit hooks

Update account & sociallogin templates

Create initial functional test template

Install & configure pytest & coverage

requirements.txt points to local cache

Use pip list --format=freeze > requirements.txt to fix.

Customize Admin header title

Update Heroku runtime to 3.10.6

Upgrade to Django 4.0.4

Add Cancel button to Profile Update page

Migrate off of Heroku platform

Generate OAuth token & configure Heroku for social login(GitHub)