A batteries-included Django starter project. To learn more try the books Django for Beginners, Django for APIs, and Django for Professionals.
- Django 4.2 & Python 3.11
- Install via Pip, Pipenv, or Docker
- User log in/out, sign up, password reset via django-allauth
- Static files configured with Whitenoise
- Styling with Bulma CSS
- Debugging with django-debug-toolbar
- DRY forms with django-crispy-forms
- Maintenance Mode django-maintenance-mode
- Custom 404, 500, and 403 error pages
DjangoBoot can be installed via Pip, Pipenv, or Docker. To start, clone the repo to your local computer and change into the proper directory. NB: We provide the raw version of the requirements.txt file.
$ git clone https://github.com/pythonbrad/django-boot.git
$ cd django-boot
$ 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 manage.py migrate
(.venv) $ python manage.py createsuperuser
(.venv) $ python manage.py runserver
# Load the site at http://127.0.0.1:8000
$ pipenv install
$ pipenv shell
(.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
Duplicate the .env_example file in .env and configure your Django application.
python ./manage.py maintenance_mode <on|off>
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 manage.py migrate
$ docker-compose exec web python manage.py createsuperuser
# Load the site at http://127.0.0.1:8000
- Add gunicorn as the production web server.
- Update the EMAIL_BACKEND and connect with a mail provider.
- Make the admin more secure.
django-allauthsupports social authentication if you need that.
I cover all of these steps in my three books: Django for Beginners, Django for APIs, and Django for Professionals.
Contributions, issues and feature requests are welcome! See CONTRIBUTING.md.
Give a ⭐️ if this project helped you!