DRFx

A framework for launching new Django Rest Framework projects quickly. Comes with a custom user model, login/logout/#, social authentication via django-allauth, and more.

Features

• Django 4, Django REST Framework 3.14, and Python 3.9.17+
• Custom user model
• Token-based auth
• #/#/logout
• django-allauth for social auth
• Pipenv for virtualenvs

First-time setup

1. Make sure Python 3.9x and Pipenv are already installed. See here for help.
2. Clone the repo and configure the virtual environment:

git clone https://github.com/dag7dev/drfx-django4.git
cd drfx
pipenv install
pipenv shell

or use requirements.txt

3. Set up the initial migration for our custom user models in users and build the database.

(drfx) $ python manage.py makemigrations users
(drfx) $ python manage.py migrate
(drfx) $ python manage.py createsuperuser
(drfx) $ python manage.py runserver

4. Endpoints

Login with your superuser account. Then navigate to all users. Logout. # for a new account and repeat the login, users, logout flow.

• login - http://127.0.0.1:8000/api/v1/auth/#/
• all users - http://127.0.0.1:8000/api/v1/users
• logout - http://127.0.0.1:8000/api/v1/auth/logout/
• # - http://127.0.0.1:8000/api/v1/auth/registration/