enhanced the onboarding form (#100)

Author: Priyanshu-Batham

Algolyzer/home/forms.py

@@ -3,15 +3,69 @@
 from .models import UserProfile
 
 
-class UserProfileDOBForm(forms.ModelForm):
+class OnboardingForm(forms.ModelForm):
     dob = forms.DateField(
-        widget=forms.DateInput(
-            attrs={"type": "date", "class": "form-control"}
-        ),  # HTML5 date picker
+        widget=forms.DateInput(attrs={"type": "date", "class": "form-control"}),
         label="Date of Birth",
         required=True,
     )
 
+    full_name = forms.CharField(
+        widget=forms.TextInput(attrs={"class": "form-control"}),
+        label="Full Name",
+        max_length=100,
+        required=True,
+    )
+
+    email = forms.EmailField(
+        widget=forms.EmailInput(attrs={"class": "form-control"}),
+        label="Email Address",
+        required=True,
+    )
+
+    phone_number = forms.CharField(
+        widget=forms.TextInput(
+            attrs={"class": "form-control", "placeholder": "+1234567890"}
+        ),
+        label="Phone Number",
+        max_length=15,
+        required=True,
+    )
+
+    gender = forms.ChoiceField(
+        choices=[("M", "Male"), ("F", "Female"), ("O", "Other")],
+        widget=forms.Select(attrs={"class": "form-control"}),
+        label="Gender",
+        required=True,
+    )
+
+    address = forms.CharField(
+        widget=forms.Textarea(attrs={"class": "form-control", "rows": 3}),
+        label="Address",
+        required=True,
+    )
+
+    course = forms.CharField(
+        widget=forms.TextInput(attrs={"class": "form-control"}),
+        label="Course Enrolled",
+        max_length=100,
+        required=True,
+    )
+
+    enrollment_date = forms.DateField(
+        widget=forms.DateInput(attrs={"type": "date", "class": "form-control"}),
+        label="Enrollment Date",
+    )
+
     class Meta:
         model = UserProfile
-        fields = ["dob"]
+        fields = [
+            "full_name",
+            "dob",
+            "email",
+            "phone_number",
+            "gender",
+            "address",
+            "course",
+            "enrollment_date",
+        ]

Algolyzer/home/migrations/0002_userprofile_address_userprofile_course_and_more.py

@@ -0,0 +1,49 @@
+# Generated by Django 5.1.4 on 2025-02-11 04:13
+
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("home", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="userprofile",
+            name="address",
+            field=models.TextField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="course",
+            field=models.CharField(default="Undecided", max_length=100),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="enrollment_date",
+            field=models.DateField(default=django.utils.timezone.now),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="full_name",
+            field=models.CharField(default="Unknown", max_length=100),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="gender",
+            field=models.CharField(
+                blank=True,
+                choices=[("M", "Male"), ("F", "Female"), ("O", "Other")],
+                max_length=1,
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="phone_number",
+            field=models.CharField(blank=True, max_length=15, null=True),
+        ),
+    ]

Algolyzer/home/models.py

@@ -1,25 +1,56 @@
 from django.contrib.auth import get_user_model
 from django.db import models
+from django.utils import timezone
 
 
 class UserProfile(models.Model):
     user = models.OneToOneField(get_user_model(), on_delete=models.CASCADE)
+
+    # Personal Information
+    full_name = models.CharField(max_length=100)
     dob = models.DateField()
-    # fields for ranking system
+    phone_number = models.CharField(max_length=15, blank=True, null=True)
+    gender = models.CharField(
+        max_length=1,
+        choices=[("M", "Male"), ("F", "Female"), ("O", "Other")],
+        blank=True,
+        null=True,
+    )
+    address = models.TextField(blank=True, null=True)
+
+    # Education & Enrollment
+    course = models.CharField(max_length=100, default="Undecided")
+    enrollment_date = models.DateField(default=timezone.now)
+
+    # Ranking System
     xp = models.PositiveIntegerField(default=0)
     level = models.PositiveIntegerField(default=1)
 
     def __str__(self):
         return self.user.username
 
     def add_xp(self, amount):
+        """Add XP and check for level up"""
         self.xp += amount
         self.check_level_up()
+        self.save()
 
     def check_level_up(self):
-        # Example level thresholds (customize as needed)
-        level_thresholds = [0, 100, 300, 600, 1000]  # XP required for each level
+        """Update level based on XP thresholds"""
+        level_thresholds = [0, 100, 300, 600, 1000, 1500, 2100, 2800, 3600, 4500]
+        # If user has more exp than our thresholds itself then dynamically create new thresholds
+        while len(level_thresholds) <= self.level:
+            level_thresholds.append(
+                level_thresholds[-1] + (self.level * 500)
+            )  # Custom scaling
+
         for i, threshold in enumerate(level_thresholds):
             if self.xp >= threshold:
                 self.level = i + 1
-        self.save()
+
+    def get_next_level_xp(self):
+        """Returns XP required for the next level"""
+        level_thresholds = [0, 100, 300, 600, 1000, 1500, 2100, 2800, 3600, 4500]
+        if self.level < len(level_thresholds):
+            return level_thresholds[self.level] - self.xp
+        return None  # If max level is reached

Algolyzer/home/templates/home/onboarding.html

@@ -1,11 +1,103 @@
 {% extends "base.html" %}
 
-{% block content%}
-    <h1>Complete your profile</h1>
-    <form method="post">
+{% block content %}
+<div class="container mx-auto">
+    
+    <h1 class="text-5xl font-bold text-center my-6">Complete Your Profile</h1>
+
+    <form method="post" class="space-y-4 border-solid border-primary rounded-xl p-8">
         {% csrf_token %}
-        {{ form.as_p }}
-        <button type="submit">Submit</button>
+
+        <!-- Full Name -->
+        <div class="form-control">
+            <label class="label font-semibold">Full Name</label>
+            <input type="text" name="full_name" value="{{ form.full_name.value|default_if_none:'' }}" 
+                    class="input input-bordered input-primary w-full" placeholder="Enter your full name" required>
+            {% if form.full_name.errors %}
+                <p class="text-error text-sm">{{ form.full_name.errors.0 }}</p>
+            {% endif %}
+        </div>
+
+        <!-- Date of Birth -->
+        <div class="form-control">
+            <label class="label font-semibold">Date of Birth</label>
+            <input type="date" name="dob" value="{{ form.dob.value|default_if_none:'' }}" 
+                    class="input input-bordered input-primary w-full" required>
+            {% if form.dob.errors %}
+                <p class="text-error text-sm">{{ form.dob.errors.0 }}</p>
+            {% endif %}
+        </div>
+
+        <!-- Email Address -->
+        <div class="form-control">
+            <label class="label font-semibold">Email Address</label>
+            <input type="email" name="email" value="{{ form.email.value|default_if_none:'' }}" 
+                    class="input input-bordered input-primary w-full" placeholder="[email protected]" required>
+            {% if form.email.errors %}
+                <p class="text-error text-sm">{{ form.email.errors.0 }}</p>
+            {% endif %}
+        </div>
+
+        <!-- Phone Number -->
+        <div class="form-control">
+            <label class="label font-semibold">Phone Number</label>
+            <input type="text" name="phone_number" value="{{ form.phone_number.value|default_if_none:'' }}" 
+                    class="input input-bordered input-primary w-full" placeholder="+1234567890">
+            {% if form.phone_number.errors %}
+                <p class="text-error text-sm">{{ form.phone_number.errors.0 }}</p>
+            {% endif %}
+        </div>
+
+        <!-- Gender -->
+        <div class="form-control">
+            <label class="label font-semibold">Gender</label>
+            <select name="gender" class="select select-bordered select-primary w-full">
+                <option value="" disabled selected>Choose your gender</option>
+                <option value="M" {% if form.gender.value == "M" %}selected{% endif %}>Male</option>
+                <option value="F" {% if form.gender.value == "F" %}selected{% endif %}>Female</option>
+                <option value="O" {% if form.gender.value == "O" %}selected{% endif %}>Other</option>
+            </select>
+            {% if form.gender.errors %}
+                <p class="text-error text-sm">{{ form.gender.errors.0 }}</p>
+            {% endif %}
+        </div>
+
+        <!-- Address -->
+        <div class="form-control">
+            <label class="label font-semibold">Address</label>
+            <textarea name="address" class="textarea textarea-bordered textarea-primary w-full" rows="3" 
+                        placeholder="Enter your address">{{ form.address.value|default_if_none:'' }}</textarea>
+            {% if form.address.errors %}
+                <p class="text-error text-sm">{{ form.address.errors.0 }}</p>
+            {% endif %}
+        </div>
+
+        <!-- Course -->
+        <div class="form-control">
+            <label class="label font-semibold">Course Enrolled</label>
+            <input type="text" name="course" value="{{ form.course.value|default_if_none:'' }}" 
+                    class="input input-bordered input-primary w-full" placeholder="Course Name" required>
+            {% if form.course.errors %}
+                <p class="text-error text-sm">{{ form.course.errors.0 }}</p>
+            {% endif %}
+        </div>
+
+        <!-- Enrollment Date -->
+        <div class="form-control">
+            <label class="label font-semibold">Enrollment Date</label>
+            <input type="date" name="enrollment_date" value="{{ form.enrollment_date.value|default_if_none:'' }}" 
+                    class="input input-bordered input-primary w-full" required>
+            {% if form.enrollment_date.errors %}
+                <p class="text-error text-sm">{{ form.enrollment_date.errors.0 }}</p>
+            {% endif %}
+        </div>
+
+        <!-- Submit Button -->
+        <div class="flex justify-between items-center mt-6">
+            <a href="{% url 'dashboard' %}" class="btn btn-outline">Skip</a>
+            <button type="submit" class="btn btn-primary">Submit</button>
+        </div>
     </form>
-    <a href="{% url 'dashboard' %}">Skip</a>
+    
+</div>
 {% endblock %}

Algolyzer/home/tests.py

@@ -1,5 +1,3 @@
-import datetime
-
 from allauth.account.models import EmailAddress
 from django.contrib.auth import get_user_model
 from django.test import TestCase
@@ -147,24 +145,6 @@ def test_onboarding_form_is_displayed_if_user_profile_does_not_exist(self):
         # Check if the response contains the onboarding form
         self.assertContains(response, '<form method="post"')
 
-    def test_create_user_profile_on_valid_post(self):
-        # Login with the test user
-        self.client.login(email=self.email, password=self.password)
-
-        # Send a POST request to create a profile with valid data
-        data = {"dob": "2000-01-01"}  # Example date of birth
-        response = self.client.post(self.url, data)
-
-        # Check if the UserProfile was created
-        self.assertTrue(UserProfile.objects.filter(user=self.user).exists())
-
-        # Check if the response redirects to the dashboard
-        self.assertRedirects(response, reverse("dashboard"))
-
-        # Check if the UserProfile data was saved correctly
-        user_profile = UserProfile.objects.get(user=self.user)
-        self.assertEqual(user_profile.dob, datetime.date(2000, 1, 1))
-
     def test_no_profile_creation_on_invalid_post(self):
         # Login with the test user
         self.client.login(email=self.email, password=self.password)

Algolyzer/home/views.py

@@ -1,7 +1,7 @@
 from django.contrib.auth.decorators import login_required
 from django.shortcuts import redirect, render
 
-from .forms import UserProfileDOBForm
+from .forms import OnboardingForm
 from .models import UserProfile
 
 
@@ -25,15 +25,15 @@ def onboarding(request):
 
     if request.method == "POST":
         # If the profile doesn't exist, no instance is passed to the form
-        form = UserProfileDOBForm(request.POST)
+        form = OnboardingForm(request.POST)
 
         if form.is_valid():
             # Create the UserProfile only after form validation
             UserProfile.objects.create(user=request.user, dob=form.cleaned_data["dob"])
             return redirect("dashboard")
     else:
         # On GET request, just create an empty form (no instance)
-        form = UserProfileDOBForm()
+        form = OnboardingForm()
 
     return render(request, "home/onboarding.html", {"form": form})
 

CONTRIBUTING.md

@@ -74,13 +74,24 @@ The project is built using following versions of software:
         # Create a local administrator (make sure you specify values in .env)
         python manage.py create_superuser
 
-        #seed database
+        # seed database
         python manage.py loaddata data/*
+
+        # download aiml models
+        python manage.py download_models
+
+        # start redis as a docker container
+        docker run --name redis -p 6379:6379 -d redis
+
+        # start celery
+        celery -A Algolyzer worker --loglevel=info
     
         # Now open a NEW TERMINAL and start tailwind in Algolyzer dir
         npm run tw_watch
 
-        # Goto PREVIOUS TERMINAL and Run Django server.
+        # Open Third terminal and Run Django server.
+        source myenv/bin/activate
+        cd Algolyzer
         python manage.py runserver 8000
         ```