djangox's Introduction

DjangoX

A framework for launching new Django projects quickly with a complete user authentication flow, custom user model, and social authentication options via Gmail, Facebook, Twitter, etc.

NOTE: This open source project is supported by my two published books Django for Beginners and REST APIs with Django. Learn how to build, test, and deploy websites with Django.

Features

For Django 2.0 and Python 3.6
Modern virtual environments with pipenv
Styling with Bootstrap v4.1.1
User registration and support for social authentication via django-allauth
Email/password for log in/sign up instead of Django's default username/email/password pattern
Custom user model
django-debug-toolbar

First-time setup

Make sure Python 3.6x and Pipenv are already installed. See here for help.
Clone the repo and configure the virtualenv:

$ git clone https://github.com/wsvincent/djangox.git
$ cd djangox
$ pipenv install
$ pipenv shell

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

(djangox) $ python manage.py makemigrations users
(djangox) $ python manage.py migrate

Create a superuser:

(djangox) $ python manage.py createsuperuser

Confirm everything is working:

(djangox) $ python manage.py runserver

Load the site at http://127.0.0.1:8000.

Next Steps

Use PostgreSQL locally via Docker
Use django-environ for environment variables
Update EMAIL_BACKEND to configure an SMTP backend
Make the admin more secure

Adding Social Authentication

Configuring Google
Configuring Facebook
Configuring Github
django-allauth supports many, many other providers in the official docs

Acknowledgments

This project is heavily inspired by cookiecutter-django. If you're looking for an even more advanced framework that comes with deployment configurations, give it a look!

Recommend Projects