.cursorrules Htmx Django

by @PatrickJS

// HTMX with Django .cursorrules

// HTMX and Django best practices

const htmxDjangoBestPractices = [
  "Use Django's template system with HTMX attributes",
  "Implement Django forms for form handling",
  "Utilize Django's URL routing system",
  "Use Django's class-based views for HTMX responses",
  "Implement Django ORM for database operations",
  "Utilize Django's middleware for request/response processing",
];

// Folder structure

const folderStructure = `
project_name/
  app_name/
    templates/
    static/
      css/
      js/
    models.py
    views.py
    urls.py
  project_name/
    settings.py
    urls.py
manage.py
`;

// Additional instructions

const additionalInstructions = `
1. Use Django's template tags with HTMX attributes
2. Implement proper CSRF protection with Django's built-in features
3. Utilize Django's HttpResponse for HTMX-specific responses
4. Use Django's form validation for HTMX requests
5. Implement proper error handling and logging
6. Follow Django's best practices for project structure
7. Use Django's staticfiles app for managing static assets
`;

HTMX with Django Development Guidelines

A set of best practices and instructions for integrating HTMX with Django, focusing on efficient and secure development:

HTMX and Django Best Practices

Use Django’s template system with HTMX attributes.
Implement Django forms for form handling and class-based views for HTMX responses.
Utilize Django’s ORM for database operations and middleware for request/response processing.

Folder Structure

Organize code into a structured directory:

textproject_name/
  app_name/
    templates/
    static/
      css/
      js/
    models.py
    views.py
    urls.py
  project_name/
    settings.py
    urls.py
manage.py

Additional Instructions

Use Django’s template tags with HTMX attributes.
Implement proper CSRF protection using Django’s built-in features.
Utilize Django’s HttpResponse for HTMX-specific responses and form validation for HTMX requests.
Follow Django’s best practices for project structure and use the staticfiles app for managing static assets.

Overview of .cursorrules prompt

HTMX and Django combine to create dynamic web applications with enhanced user interaction. HTMX allows developers to access modern browser features directly from HTML, simplifying the integration of AJAX, CSS transitions, and WebSockets into Django projects. This integration enables features like live form submissions, real-time updates, and infinite scrolling, all while maintaining Django’s robust backend capabilities. Key considerations include configuring CSRF tokens for secure communication and leveraging Django’s template system and URL routing to support HTMX attributes. By combining these technologies, developers can build responsive, interactive web applications with minimal JavaScript, keeping more logic server-side for better performance and maintainability.

Updated: March 15, 2025

This prompt outlines integrating HTMX with Django to create dynamic web applications, leveraging HTMX for interactive front-end capabilities while maintaining Django's robust backend features.

Usefull for: