.. django-flex-user documentation master file, created by
   sphinx-quickstart on Fri Oct  8 19:26:03 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to django-flex-user's documentation!
============================================

A flexible user model for Django designed to **maximize sign-up conversion**.

Enables users to up using their choice of **username**, **email address**, **phone number** or any combination thereof.
Users can also sign up using an **OAuth** provider like Facebook or Google.

Email address and phone number **verification**, **password reset**, and **REST API** included "in the box".

Click `here <https://django-flex-user.herokuapp.com/>`__ to see a **demo**.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   before_you_begin
   installation
   basic_configuration
   oauth_configuration
   rest_api_configuration
   basic_usage
   reference_project

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`