kolynzb / drf-djsr-temp

Django Rest framework djoser authentication API template

Django & Djoser API Authetication Starter Template

• This is a template for django API authentication with djoser

• ⚠️ Still a Under Contruction

• Application Programming interface for a auth built in django, Djoser and djangorestframework with python.

Highlights

• Modern Python development with Python 3.11+
• Bleeding edge Django 4.0+
• Fully dockerized, local development via docker-compose.
• PostgreSQL
• Full test coverage, continuous integration, and continuous deployment.
• Celery tasks

Features built-in

• Email and Password Authetication with Djoser.
• Custom User
• Code Formating with Black,Flake8 & isort
• Social (FB + G+) signup/sigin
• Custom API Home Page
• Custom Email Templates
• Custom Profile Model
• Tests (with mocking and factories) with code-coverage support
• Swagger API docs out-of-the-box
• Password reset endpoints
• Health checks on /health route

Table Of Contents

• Project Folder Structure
• Django Apps
• How to Run API Locally

Folder Structure

C:.
├───conf
├───docs
├───accounts
├── apps
│   ├──
│   └── core
└── README.md

Django Apps

• Config
  • App containing django project settings and rject configurations.
• Accounts
  • App to control User Accounts , models and Profiles.
• Core
  • App for core logic .

How to Run Project

• 👉🏿Click Me👈🏿 to get project installation instrutions.

Python Version

• python 3.11.0
• Check runtime.txt file

Important Urls

1. Visit the browsable API at http://localhost:8000/api/v1/

2. Access the Django admin at http://localhost:8000/admin

3. Visit reDoc documentation http://localhost:8000/redoc

4. Visit Swagger documentation http://localhost:8000/doc

5. Visit API Home Page http://localhost:8000

6. To access useful links and tutorial that helped during the project click me 😉

Concept Diagrams

• Link to ERD Diagram