Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?


Failed to load latest commit information.
Latest commit message
Commit time

A batteries-included Django starter project. To learn more try the books Django for Beginners, Django for APIs, and Django for Professionals.

πŸš€ Features

Table of Contents

πŸ“– Installation

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

$ git clone
$ cd djangox


$ python -m venv .venv

# Windows
$ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
$ .venv\Scripts\Activate.ps1

# macOS
$ source .venv/bin/activate

(.venv) $ pip install -r requirements.txt
(.venv) $ python migrate
(.venv) $ python createsuperuser
(.venv) $ python runserver
# Load the site at


To use Docker with PostgreSQL as the database update the DATABASES section of django_project/ to reflect the following:

# django_project/
    "default": {
        "ENGINE": "django.db.backends.postgresql",
        "NAME": "postgres",
        "USER": "postgres",
        "PASSWORD": "postgres",
        "HOST": "db",  # set in docker-compose.yml
        "PORT": 5432,  # default postgres port

The INTERNAL_IPS configuration in django_project/ must be also be updated:

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

And then proceed to build the Docker image, run the container, and execute the standard commands within Docker.

$ docker-compose up -d --build
$ docker-compose exec web python migrate
$ docker-compose exec web python createsuperuser
# Load the site at

Next Steps

I cover all of these steps in my three books: Django for Beginners, Django for APIs, and Django for Professionals.

🀝 Contributing

Contributions, issues and feature requests are welcome! See

⭐️ Support

Give a ⭐️ if this project helped you!


The MIT License