Feat : Badges : Allow users to embed digital badges on profiles and websites

web/admin.py

@@ -10,6 +10,7 @@
 
 from .models import (
     Achievement,
+    Badge,
     BlogComment,
     BlogPost,
     Cart,
@@ -43,6 +44,7 @@
     Storefront,
     Subject,
     SuccessStory,
+    UserBadge,
     WebRequest,
 )
 
@@ -617,6 +619,21 @@ def display_name(self, obj):
     display_name.short_description = "Name"
 
 
+
+@admin.register(Badge)
+class BadgeAdmin(admin.ModelAdmin):
+    list_display = ("name", "badge_type", "is_active", "created_by", "created_at")
+    list_filter = ("badge_type", "is_active")
+    search_fields = ("name", "description")
+
+
+@admin.register(UserBadge)
+class UserBadgeAdmin(admin.ModelAdmin):
+    list_display = ("user", "badge", "award_method", "awarded_at")
+    list_filter = ("award_method", "badge__badge_type")
+    search_fields = ("user__username", "badge__name")
+    date_hierarchy = "awarded_at"
+
 @admin.register(LearningStreak)
 class LearningStreakAdmin(admin.ModelAdmin):
     list_display = ("user", "current_streak", "longest_streak", "last_engagement")
@@ -646,3 +663,5 @@ class QuizOptionAdmin(admin.ModelAdmin):
     list_filter = ("is_correct",)
     search_fields = ("text", "question__text")
     autocomplete_fields = ["question"]
+
+

web/migrations/0029_badge_userbadge.py

@@ -0,0 +1,138 @@
+# Generated by Django 5.1.6 on 2025-03-19 07:24
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("web", "0028_certificate"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Badge",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("name", models.CharField(max_length=100)),
+                ("description", models.TextField()),
+                ("image", models.ImageField(upload_to="badges/")),
+                (
+                    "badge_type",
+                    models.CharField(
+                        choices=[
+                            ("challenge", "Challenge Completion"),
+                            ("course", "Course Completion"),
+                            ("achievement", "Special Achievement"),
+                            ("teacher_awarded", "Teacher Awarded"),
+                        ],
+                        max_length=20,
+                    ),
+                ),
+                ("is_active", models.BooleanField(default=True)),
+                ("criteria", models.JSONField(blank=True, default=dict)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "challenge",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="badges",
+                        to="web.challenge",
+                    ),
+                ),
+                (
+                    "course",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="badges",
+                        to="web.course",
+                    ),
+                ),
+                (
+                    "created_by",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="created_badges",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["badge_type", "name"],
+            },
+        ),
+        migrations.CreateModel(
+            name="UserBadge",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "award_method",
+                    models.CharField(
+                        choices=[
+                            ("challenge_completion", "Challenge Completion"),
+                            ("course_completion", "Course Completion"),
+                            ("teacher_awarded", "Teacher Awarded"),
+                            ("system_awarded", "System Awarded"),
+                        ],
+                        max_length=20,
+                    ),
+                ),
+                ("awarded_at", models.DateTimeField(auto_now_add=True)),
+                ("award_message", models.TextField(blank=True)),
+                (
+                    "awarded_by",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="awarded_badges",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "badge",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, related_name="awarded_to", to="web.badge"
+                    ),
+                ),
+                (
+                    "challenge_submission",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="badges",
+                        to="web.challengesubmission",
+                    ),
+                ),
+                (
+                    "course_enrollment",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="badges",
+                        to="web.enrollment",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, related_name="badges", to=settings.AUTH_USER_MODEL
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["-awarded_at"],
+                "unique_together": {("user", "badge")},
+            },
+        ),
+    ]

web/models.py

@@ -1439,6 +1439,139 @@ def display_name(self):
         return self.email.split("@")[0]  # Use part before @ in email
 
 
+class Badge(models.Model):
+    BADGE_TYPES = [
+        ("challenge", "Challenge Completion"),
+        ("course", "Course Completion"),
+        ("achievement", "Special Achievement"),
+        ("teacher_awarded", "Teacher Awarded"),
+    ]
+    name = models.CharField(max_length=100)
+    description = models.TextField()
+    image = models.ImageField(upload_to="badges/")
+    badge_type = models.CharField(max_length=20, choices=BADGE_TYPES)
+    course = models.ForeignKey(Course, on_delete=models.CASCADE, null=True, blank=True, related_name="badges")
+    challenge = models.ForeignKey(Challenge, on_delete=models.CASCADE, null=True, blank=True, related_name="badges")
+    created_by = models.ForeignKey(User, on_delete=models.CASCADE, related_name="created_badges")
+    is_active = models.BooleanField(default=True)
+    criteria = models.JSONField(default=dict, blank=True)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return self.name
+
+    def save(self, *args, **kwargs):
+        if self.image:
+            img = Image.open(self.image)
+            if img.mode != "RGB":
+                img = img.convert("RGB")
+            img = img.resize((200, 200), Image.Resampling.LANCZOS)
+            buffer = BytesIO()
+            img.save(buffer, format="PNG", quality=90)
+            file_name = self.image.name
+            self.image.delete(save=False)
+            self.image.save(file_name, ContentFile(buffer.getvalue()), save=False)
+        super().save(*args, **kwargs)
+
+    class Meta:
+        ordering = ["badge_type", "name"]
+
+
+class UserBadge(models.Model):
+    AWARD_METHODS = [
+        ("challenge_completion", "Challenge Completion"),
+        ("course_completion", "Course Completion"),
+        ("teacher_awarded", "Teacher Awarded"),
+        ("system_awarded", "System Awarded"),
+    ]
+    user = models.ForeignKey(User, on_delete=models.CASCADE, related_name="badges")
+    badge = models.ForeignKey(Badge, on_delete=models.CASCADE, related_name="awarded_to")
+    award_method = models.CharField(max_length=20, choices=AWARD_METHODS)
+    awarded_at = models.DateTimeField(auto_now_add=True)
+    challenge_submission = models.ForeignKey(
+        ChallengeSubmission, on_delete=models.SET_NULL, null=True, blank=True, related_name="badges"
+    )
+    course_enrollment = models.ForeignKey(
+        Enrollment, on_delete=models.SET_NULL, null=True, blank=True, related_name="badges"
+    )
+    awarded_by = models.ForeignKey(
+        User, on_delete=models.SET_NULL, null=True, blank=True, related_name="awarded_badges"
+    )
+    award_message = models.TextField(blank=True)
+
+    def __str__(self):
+        return f"{self.user.username} - {self.badge.name}"
+
+    class Meta:
+        unique_together = ["user", "badge"]
+        ordering = ["-awarded_at"]
+
+
+@receiver(post_save, sender=ChallengeSubmission)
+def award_challenge_badge(sender, instance, created, **kwargs):
+    if created:
+        challenge_badges = Badge.objects.filter(challenge=instance.challenge, badge_type="challenge", is_active=True)
+        for badge in challenge_badges:
+            if not UserBadge.objects.filter(user=instance.user, badge=badge).exists():
+                UserBadge.objects.create(
+                    user=instance.user, badge=badge, award_method="challenge_completion", challenge_submission=instance
+                )
+                Notification.objects.create(
+                    user=instance.user,
+                    title=f"New Badge: {badge.name}",
+                    message=f"Congrats! You've earned {badge.name} for completing {instance.challenge.title}",
+                    notification_type="success",
+                )
+
+
+@receiver(post_save, sender=Enrollment)
+def award_course_completion_badge(sender, instance, **kwargs):
+    if instance.status == "completed":
+        course_badges = Badge.objects.filter(course=instance.course, badge_type="course", is_active=True)
+        for badge in course_badges:
+            if not UserBadge.objects.filter(user=instance.student, badge=badge).exists():
+                UserBadge.objects.create(
+                    user=instance.student, badge=badge, award_method="course_completion", course_enrollment=instance
+                )
+                Notification.objects.create(
+                    user=instance.student,
+                    title=f"New Badge: {badge.name}",
+                    message=f"Congrats! You've earned {badge.name} for completing {instance.course.title}",
+                    notification_type="success",
+                )
+
+
+def award_badge_to_student(badge_id, student_id, teacher_id, message=""):
+    try:
+        badge = Badge.objects.get(id=badge_id)
+        student = User.objects.get(id=student_id)
+        teacher = User.objects.get(id=teacher_id)
+        if not teacher.profile.is_teacher:
+            return None
+        if UserBadge.objects.filter(user=student, badge=badge).exists():
+            return None
+        user_badge = UserBadge.objects.create(
+            user=student, badge=badge, award_method="teacher_awarded", awarded_by=teacher, award_message=message
+        )
+        Notification.objects.create(
+            user=student,
+            title=f"New Badge: {badge.name}",
+            message=f"You were awarded {badge.name} by {teacher.username}. {message}",
+            notification_type="success",
+        )
+        return user_badge
+    except (Badge.DoesNotExist, User.DoesNotExist):
+        return None
+
+
+def get_user_badges(self):
+    return UserBadge.objects.filter(user=self.user)
+
+
+Profile.get_user_badges = get_user_badges
+
+
 class Certificate(models.Model):
     # Certificate Model
     certificate_id = models.UUIDField(default=uuid.uuid4, editable=False, unique=True)

web/templates/profile.html

@@ -351,6 +351,25 @@ <h3 class="font-medium">{{ enrollment.course.title }}</h3>
                 </div>
               {% endif %}
             </div>
+            <div class="p-6">
+              <h2 class="text-xl font-semibold mb-6">My Badges</h2>
+              {% if badges %}
+                {% for user_badge in badges %}
+                  <div class="badge-item">
+                    <img src="{{ user_badge.badge.image.url }}"
+                         alt="{{ user_badge.badge.name }}" />
+                    <p>{{ user_badge.badge.name }}</p>
+                  </div>
+                {% endfor %}
+              {% else %}
+                <div class="text-center py-8">
+                  <div class="text-gray-400 dark:text-gray-500 mb-4">
+                    <i class="fas fa-award text-4xl"></i>
+                  </div>
+                  <p class="text-gray-600 dark:text-gray-300 mb-4">You haven't earned any badges yet.</p>
+                </div>
+              {% endif %}
+            </div>
           </div>
         {% endif %}
       </div>

web/views.py

@@ -129,6 +129,7 @@
     TeamGoalMember,
     TeamInvite,
     TimeSlot,
+    UserBadge,
     WebRequest,
 )
 from .notifications import (
@@ -276,7 +277,14 @@ def profile(request):
         # Use the instance so the form loads all updated fields from the database.
         form = ProfileUpdateForm(instance=request.user)
 
-    context = {"form": form}
+
+    badges = UserBadge.objects.filter(user=request.user).select_related("badge")
+
+    context = {
+        "form": form,
+        "badges": badges,
+    }
+
 
     # Teacher-specific stats
     if request.user.profile.is_teacher: