Reference Project

For convenience, we provide a reference project which implements all of the conventional user-flows for sign up, sign in and account management. Feel free to use this project to guide your implementation of django_flex_user.

You can try a live version of the reference project here. Or, you can run the reference project on your local machine.

Running the reference project locally

  1. Clone the git repository:

    $ mkdir django-flex-user
    $ cd django-flex-user
    $ git clone
  2. Create an .env file with the following contents:



    Replace ellipses with the values you obtain by following the instructions below:

    • For Sendgrid, click here to obtain an API key.

    • For Facebook Login, click here to obtain an “App ID” and “Secret Key”.

    • For Google Sign-In, click here to obtain an “OAuth Client ID” and “Client Secret”.

  3. Install dependencies:

    $ python -m pipenv install --dev


    On Windows, the command to execute Python is py.

  4. Activate the pipenv shell:

    $ python -m pipenv shell
  5. Initialize database tables:

    $ python migrate
  6. Create a super user:

    $ python createsuperuser
  7. Run the development server:

    $ python runserver
  8. Run tests:

    $ python test
  9. Build the Python package:

    $ python sdist
  10. Build the docs:

    $ cd doc
    $ sphinx-apidoc -o source ../django_flex_user ../django_flex_user/tests ../django_flex_user/migrations
    $ make html


    If you’re running Git Bash on Windows, the last command should be ./make.bat html