Boilerplate Django project

Home

https://djpoe.com

Articles

Development of DJPoe is accompanied by a series of in-depth articles, providing step-by-step explanations of each feature integration and the rationale behind design decisions. These articles serve as both documentation and a learning resource for developers looking to understand the intricacies of building a robust Django application.

1. "Django with Poetry"
2. "Linting Django"
3. "Lint and Test with GitHub Actions"
4. "Deploy Django on DigitalOcean"
5. "3rd party authentication in Django"
6. "Wagtail CMS for the content"
7. "Customizing DJPoe: A Script for Rapid Django Project Initialization"

Installation

Morph into your project

sh <(curl -sSL https://raw.githubusercontent.com/zalun/djpoe/refs/heads/main/scripts/install.sh)

Set variables

The system uses the following environment variables. Some of them are required.

• DEBUG - Is the server in debug mode (default: False)
• DATABASE_URL - Ddatabase URL (default: "sqlite:///djpoe/db.sqlite3")
• SECRET_KEY - A random string unique per installation (required)
• ACCOUNT_AUTHENTICATION_METHOD - (default: "email")
• ACCOUNT_EMAIL_REQUIRED - (default: True)
• GOOGLE_AUTH_CLIENT_ID - Google OAuth client ID (required)
• GOOGLE_AUTH_CLIENT_SECRET - Google OAuth client secret (required)
• WAGTAIL_SITE_NAME - Name used in the CMS (deefault: "DJPoe")
• WAGTAILADMIN_BASE_URL - URL used in Wagtail notifications (default: "http://localhost:8001")
• DEFAULT_FROM_EMAIL - Email used as author of Django emails (default: "email@example.com")
• AWS_BUCKET_NAME - Bucket name for the media storage (required)
• AWS_REGION_NAME - AWS region name for the media storage (required)
• AWS_ACCESS_KEY - AWS access key for the media storage (required)
• AWS_SECRET_KEY - AWS secret key for the media storage (required)

Migrate the database

$ poe migrate
Operations to perform:
  Apply all migrations: account, admin, auth, contenttypes, sessions, socialaccount
Running migrations:
  Applying account.0001_initial... OK
  Applying account.0002_email_max_length... OK
  Applying account.0003_alter_emailaddress_create_unique_verified_email... OK
  Applying account.0004_alter_emailaddress_drop_unique_email... OK
  Applying account.0005_emailaddress_idx_upper_email... OK
  Applying account.0006_emailaddress_lower... OK
  Applying account.0007_emailaddress_idx_email... OK
  Applying account.0008_emailaddress_unique_primary_email_fixup... OK
  Applying account.0009_emailaddress_unique_primary_email... OK
  Applying socialaccount.0001_initial... OK
  Applying socialaccount.0002_token_max_lengths... OK
  Applying socialaccount.0003_extra_data_default_dict... OK
  Applying socialaccount.0004_app_provider_id_settings... OK
  Applying socialaccount.0005_socialtoken_nullable_app... OK
  Applying socialaccount.0006_alter_socialaccount_extra_data... OK
  ... A lot of wagtail migrations

Add homepage from fixture

$ poe manage loaddata homepage
Poe => python ./djpoe/manage.py loaddata homepage
Installed 4 object(s) from 1 fixture(s)

Run locally

To run it locally call poe dev and navigate to the http://127.0.0.1:8001.

$ poe dev
Poe => python ./djpoe/manage.py runserver 127.0.0.1:8001
Watching for file changes with StatReloader
Performing system checks...

August 16, 2024 - 03:26:02
Django version 5.1, using settings 'djpoe.settings'
Starting development server at http://127.0.0.1:8001/
Quit the server with CONTROL-C.

Deployment

Look into "Deploy Django on DigitalOcean" and modify the GitHub variables accordingly.