sweetlearn/myproject

A Django starter project that "just works."

NOTE: This open source project is supported by LearnDjango.com which has free tutorials and premium courses.

Demo

Features

• Django 3.0 & Python 3.7
• Custom user model
• Email/password for user registration and log in
• Static files properly configured, including Favicon
• django-allauth for social authentication
• Bootstrap for styling
• django-debug-toolbar for debugging
• django-crispy-forms for DRY forms

First-time setup

1. Make sure Python 3.7x and Pipenv are already installed. See here for help.

2. Clone the repo and configure the virtual environment:

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

3. 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

4. Create a superuser:

(djangox) $ python manage.py createsuperuser

5. Confirm everything is working:

(djangox) $ python manage.py runserver

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

6. To customize the name of the project, update 3 files by replacing "djangox_project" with your desired name:

• manage.py
• djangox_project/settings.py
• djangox_project/wsgi.py

It's also possible to change the djangox_project directory to your desired project name.

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

Contributing

See CONTRIBUTING.md.