Add django with d1 template

Author: G4brym

16-django-with-d1/.gitignore

@@ -0,0 +1,74 @@
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# public
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# wrangler project
+
+.dev.vars
+.wrangler/
+.idea
+node_modules
+staticfiles
+python_modules
+.venv
+.venv-workers

16-django-with-d1/README.md

@@ -0,0 +1,145 @@
+# Django D1 Template for Cloudflare Workers
+
+This template provides a starting point for running a Django application on Cloudflare Workers, utilizing Cloudflare D1 for serverless SQL database.
+
+[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/G4brym/django-cf/tree/main/templates/d1)
+
+## Overview
+
+This template is pre-configured to:
+- Use `django-cf` to bridge Django with Cloudflare's environment.
+- Employ Cloudflare D1 as the primary data store through the `django_cf.db.backends.d1` database engine.
+- Include a basic Django project structure within the `src/` directory.
+- Provide example worker entrypoint (`src/index.py`).
+
+## Project Structure
+
+```
+template-root/
+ |-> src/
+ |    |-> manage.py             # Django management script
+ |    |-> index.py              # Cloudflare Worker entrypoint
+ |    |-> app/                  # Your Django project (rename as needed)
+ |    |    |-> settings.py       # Django settings, configured for D1
+ |    |    |-> urls.py           # Django URLs, includes management endpoints
+ |    |    |-> wsgi.py           # WSGI application
+ |    |-> your_django_apps/     # Add your Django apps here
+ |    |-> vendor/               # Project dependencies (managed by vendor.txt)
+ |-> staticfiles/              # Collected static files (after build)
+ |-> .gitignore
+ |-> package.json              # For Node.js dependencies like wrangler
+ |-> uv.lock                   # Python dependencies lock file
+ |-> pyproject.toml            # Python project configuration
+ |-> wrangler.jsonc            # Wrangler configuration
+```
+
+## Setup and Deployment
+
+1.  **Install Dependencies:**
+    Ensure you have Node.js, npm, and Python installed. Then:
+
+    ```bash
+    # Install Node.js dependencies
+    npm install
+
+    # Install Python dependencies
+    uv sync
+    ```
+
+    If you don't have `uv` installed, install it first:
+    ```bash
+    pip install uv
+    ```
+
+2.  **Configure `wrangler.jsonc`:**
+    Review and update `wrangler.jsonc` for your project. Key sections:
+    *   `name`: Your worker's name.
+    *   `compatibility_date`: Keep this up-to-date.
+    *   `d1_databases`:
+        *   `binding`: The name used to access the D1 database in your worker (e.g., "DB").
+        *   `database_name`: The name of your D1 database in the Cloudflare dashboard.
+        *   `database_id`: The ID of your D1 database.
+
+    Example `d1_databases` configuration in `wrangler.jsonc`:
+    ```jsonc
+    {
+      "d1_databases": [
+        {
+          "binding": "DB",
+          "database_name": "my-django-db",
+          "database_id": "your-d1-database-id-here"
+        }
+      ]
+    }
+    ```
+
+3.  **Django Settings (`src/app/settings.py`):**
+    The template should be configured to use D1 binding:
+    ```python
+    # src/app/settings.py
+    DATABASES = {
+        'default': {
+            'ENGINE': 'django_cf.db.backends.d1',
+            # This name 'DB' must match the 'binding' in your wrangler.jsonc d1_databases section
+            'CLOUDFLARE_BINDING': 'DB',
+        }
+    }
+    ```
+
+4.  **Worker Entrypoint (`src/index.py`):**
+    This file contains the main worker handler for your Django application.
+    ```python
+    from workers import WorkerEntrypoint
+    from django_cf import DjangoCF
+
+    class Default(DjangoCF, WorkerEntrypoint):
+        async def get_app(self):
+            from app.wsgi import application
+            return application
+    ```
+
+5.  **Run Development Server:**
+    ```bash
+    npm run dev
+    ```
+    This starts the local development server using Wrangler.
+
+6.  **Deploy to Cloudflare:**
+    ```bash
+    npm run deploy
+    ```
+    This command installs system dependencies and deploys your worker to Cloudflare.
+
+## Running Management Commands
+
+For D1, you can use the special management endpoints provided in the template:
+
+*   **`/__run_migrations__/`**: Triggers the `migrate` command.
+*   **`/__create_admin__/`**: Creates a superuser (username: 'admin', password: 'password').
+
+These endpoints are defined in `src/app/urls.py` and are protected by `user_passes_test(is_superuser)`. This means you must first create an admin user and be logged in as that user to access these endpoints.
+
+**Initial Admin User Creation:**
+For the very first admin user creation, you might need to temporarily remove the `@user_passes_test(is_superuser)` decorator from `create_admin_view` in `src/app/urls.py`, deploy, access `/__create_admin__/`, and then reinstate the decorator and redeploy. Alternatively, modify the `create_admin_view` to accept a secure token or other mechanism for the initial setup if direct unauthenticated access is undesirable.
+
+**Accessing the Endpoints:**
+Once deployed and an admin user exists (and you are logged in as them):
+- Visit `https://your-worker-url.com/__run_migrations__/` to apply migrations.
+- Visit `https://your-worker-url.com/__create_admin__/` to create the admin user if needed.
+
+Check the JSON response in your browser to see the status of the command.
+
+## Development Notes
+
+*   **D1 Limitations:**
+    *   **Transactions are disabled** for D1. Every query is committed immediately. This is a fundamental aspect of D1.
+    *   The D1 backend has some limitations compared to traditional SQLite or other SQL databases. Many advanced ORM features or direct SQL functions (especially those used in Django Admin) might not be fully supported. Refer to the `django-cf` README and official Cloudflare D1 documentation.
+    *   Django Admin functionality might be limited.
+*   **Local Testing with D1:**
+    *   Wrangler allows local development and can simulate D1 access. `npx wrangler dev --remote` can connect to your actual D1 database for more accurate testing.
+*   **Security:**
+    *   The management command endpoints are protected by Django's `user_passes_test(is_superuser)`. Ensure they are properly secured before deploying to production.
+    *   Protect your Cloudflare credentials and API tokens.
+
+---
+*For more details on `django-cf` features and configurations, refer to the main [django-cf GitHub repository](https://github.com/G4brym/django-cf).*

16-django-with-d1/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "django-with-d1",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "deploy": "uv run pywrangler deploy",
+    "dev": "uv run pywrangler dev",
+    "start": "uv run pywrangler dev"
+  },
+  "devDependencies": {
+    "wrangler": "^4.51.0"
+  }
+}

16-django-with-d1/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "django-on-workers-with-d1"
+version = "0.1.0"
+description = "This template provides a starting point for running a Django application on Cloudflare Workers, utilizing Cloudflare D1 for serverless SQL database."
+requires-python = ">=3.12"
+readme = "README.md"
+dependencies = [
+    "django-cf",
+    "django==5.2.6",
+    "tzdata",
+]
+
+[dependency-groups]
+dev = [
+    "workers-py",
+    "workers-runtime-sdk"
+]

16-django-with-d1/src/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for app project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "app.settings")
+
+application = get_asgi_application()