2020-03-01 07:51:56 +03:00
|
|
|
# Dj-Rest-Auth
|
2020-03-01 07:53:34 +03:00
|
|
|
[![<iMerica>](https://circleci.com/gh/iMerica/dj-rest-auth.svg?style=svg)](https://app.circleci.com/github/iMerica/dj-rest-auth/pipelines)
|
2020-03-01 07:51:56 +03:00
|
|
|
|
|
|
|
|
2020-03-01 09:06:45 +03:00
|
|
|
Drop-in API endpoints for handling authentication securely in Django Rest Framework. Works especially well
|
|
|
|
with with SPAs (e.g React, Vue, Angular), and Mobile applications.
|
2020-03-01 08:02:01 +03:00
|
|
|
|
2020-03-01 08:23:47 +03:00
|
|
|
## Requirements
|
2020-03-01 08:02:01 +03:00
|
|
|
- Django 2 or 3.
|
|
|
|
- Python 3
|
|
|
|
|
2020-03-01 08:23:47 +03:00
|
|
|
## Quick Setup
|
2020-03-01 08:02:01 +03:00
|
|
|
|
|
|
|
Install package
|
|
|
|
|
|
|
|
pip install dj-rest-auth
|
|
|
|
|
|
|
|
Add `dj_rest_auth` app to INSTALLED_APPS in your django settings.py:
|
|
|
|
|
|
|
|
INSTALLED_APPS = (
|
|
|
|
...,
|
|
|
|
'rest_framework',
|
|
|
|
'rest_framework.authtoken',
|
|
|
|
...,
|
2020-03-01 08:03:58 +03:00
|
|
|
'dj_rest_auth'
|
2020-03-01 08:02:01 +03:00
|
|
|
)
|
|
|
|
|
|
|
|
Add URL patterns
|
|
|
|
|
|
|
|
|
|
|
|
urlpatterns = [
|
|
|
|
url(r'^dj-rest-auth/', include('dj_rest_auth.urls'))
|
|
|
|
]
|
|
|
|
|
2020-03-01 08:23:47 +03:00
|
|
|
### Documentation
|
|
|
|
|
|
|
|
View the full documentation here: https://dj-rest-auth.readthedocs.io/en/latest/index.html
|
|
|
|
|
2020-03-01 08:06:12 +03:00
|
|
|
|
|
|
|
### Acknowledgements
|
|
|
|
|
|
|
|
This project began as a fork of `django-rest-auth`. Big thanks to everyone who contributed to that repo!
|