djangox

A batteries-included Django starter project. For a production-ready version see the book Django for Professionals.

🚀 Features

• Django 4.0 & Python 3.10
• Install via Pip, Pipenv, or Docker
• User log in/out, sign up, password reset via django-allauth
• Static files configured with Whitenoise
• Styling with Bootstrap v4
• Debugging with django-debug-toolbar
• DRY forms with django-crispy-forms

Table of Contents

• Installation
  • Pip
  • Pipenv
  • Docker
• Setup
• Contributing
• Support
• License

---

📖 Installation

DjangoX can be installed via Pip, Pipenv, or Docker depending upon your setup. To start, clone the repo to your local computer and change into the proper directory.

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

Pip

$ python3 -m venv .venv
$ source djangox/bin/activate
(.venv) $ pip install -r requirements.txt
(.venv) $ python manage.py migrate
(.venv) $ python manage.py createsuperuser
(.venv) $ python manage.py runserver
# Load the site at http://127.0.0.1:8000

Pipenv

$ pipenv install
$ pipenv shell
(djangox) $ python manage.py migrate
(djangox) $ python manage.py createsuperuser
(djangox) $ python manage.py runserver
# Load the site at http://127.0.0.1:8000

Docker

$ docker-compose up -d --build
$ docker-compose exec web python manage.py migrate
$ docker-compose exec web python manage.py createsuperuser
# Load the site at http://127.0.0.1:8000

For Docker, the INTERNAL_IPS configuration in django_project/settings.py must be updated to the following:

# config/settings.py
# django-debug-toolbar
import socket
hostname, _, ips = socket.gethostbyname_ex(socket.gethostname())
INTERNAL_IPS = [ip[:-1] + "1" for ip in ips]

Setup

# Run Migrations
(.venv) $ python manage.py migrate

# Create a Superuser
(.venv) $ python manage.py createsuperuser

# Confirm everything is working:
(.venv) $ python manage.py runserver

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

---

🤝 Contributing

Contributions, issues and feature requests are welcome! See CONTRIBUTING.md.

⭐️ Support

Give a ⭐️ if this project helped you!

License

The MIT License