Merge pull request #32 from yld-weng/test/ylw

build: add django-debug-toolbar

Author: f-allian

README.md

@@ -59,7 +59,15 @@ python manage.py createsuperuser
 
 ---
 
-6. Finally, run start the development server
+6. Create a `.env` file in the project root directory and add the following environment variables:
+
+```
+DJANGO_SECRET_KEY=your_secret_key
+```
+
+---
+
+7. Finally, run start the development server
 ```bash
 python manage.py runserver
 ```

SORT/settings.py

@@ -43,6 +43,7 @@
     "django.contrib.staticfiles",
     "django_bootstrap5",
     "django_extensions",
+    'debug_toolbar',
 
     # apps created by FA:
 
@@ -59,6 +60,7 @@
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    'debug_toolbar.middleware.DebugToolbarMiddleware'
 ]
 
 ROOT_URLCONF = "SORT.urls"
@@ -163,7 +165,14 @@
     'django.contrib.auth.backends.ModelBackend',
 )
 
+# For django-debug-toolbar
+INTERNAL_IPS = [
+    # ...
+    "127.0.0.1",
+    # ...
+]
 
 # FA: for production:
 
 #EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
+

SORT/urls.py

@@ -14,10 +14,17 @@
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+from django.conf import settings
 from django.contrib import admin
 from django.urls import path, include
 
 urlpatterns = [
     path("admin/", admin.site.urls),
     path("", include("home.urls")),
 ]
+
+if settings.DEBUG:
+    import debug_toolbar
+    urlpatterns += [
+        path('__debug__/', include(debug_toolbar.urls)),
+    ]

requirements.txt

@@ -24,3 +24,4 @@ traitlets==5.14.3
 typing_extensions==4.12.2
 tzdata==2024.1
 wcwidth==0.2.13
+django_debug_toolbar==4.4.6