Skip to content

Commit 0f24fed

Browse files
committed
feat: add Google and GitHub OAuth sign-in alongside email/password auth
- Add allauth.socialaccount with Google and GitHub providers to INSTALLED_APPS - Create CustomSocialAccountAdapter for email matching and profile creation - Add branded OAuth buttons to login and signup templates (responsive + dark mode) - Create socialaccount signup and connections templates - Update set_user_type signal to handle social signups safely - Add 17 tests covering OAuth buttons, adapter logic, and profile creation - OAuth credentials read from environment variables (no secrets in code)
1 parent 7e7a7e1 commit 0f24fed

8 files changed

Lines changed: 635 additions & 2 deletions

File tree

web/adapters.py

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
import logging
2+
3+
from allauth.socialaccount.adapter import DefaultSocialAccountAdapter
4+
from django.contrib.auth.models import User
5+
6+
logger = logging.getLogger(__name__)
7+
8+
9+
class CustomSocialAccountAdapter(DefaultSocialAccountAdapter):
10+
"""Custom adapter to handle social account signups and profile creation."""
11+
12+
def pre_social_login(self, request, sociallogin):
13+
"""
14+
Connect social login to existing account if emails match.
15+
16+
When a user signs up with email/password first, then later tries
17+
to log in with Google/GitHub using the same email, this links
18+
the social account to the existing user instead of creating a duplicate.
19+
"""
20+
if sociallogin.is_existing:
21+
return
22+
23+
email = None
24+
if sociallogin.account.extra_data:
25+
email = sociallogin.account.extra_data.get("email")
26+
27+
if not email:
28+
email_addresses = sociallogin.email_addresses
29+
if email_addresses:
30+
email = email_addresses[0].email
31+
32+
if email:
33+
try:
34+
user = User.objects.get(email=email)
35+
sociallogin.connect(request, user)
36+
except User.DoesNotExist:
37+
pass
38+
39+
def populate_user(self, request, sociallogin, data):
40+
"""Populate user fields from social account data."""
41+
user = super().populate_user(request, sociallogin, data)
42+
43+
# Ensure first_name and last_name are set from social provider data
44+
if not user.first_name:
45+
user.first_name = data.get("first_name", "")
46+
if not user.last_name:
47+
user.last_name = data.get("last_name", "")
48+
49+
return user
50+
51+
def save_user(self, request, sociallogin, form=None):
52+
"""Save user and ensure profile is properly set up after social signup."""
53+
user = super().save_user(request, sociallogin, form)
54+
55+
# Ensure profile exists and set defaults for social signups
56+
if hasattr(user, "profile"):
57+
profile = user.profile
58+
# Social signups default to private profile and student role
59+
if not profile.is_profile_public:
60+
profile.is_profile_public = False
61+
profile.save()
62+
63+
return user

web/models.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1159,8 +1159,12 @@ def reading_time(self):
11591159

11601160
@receiver(user_signed_up)
11611161
def set_user_type(sender, request, user, **kwargs):
1162-
"""Set the user type (teacher/student) when they sign up."""
1163-
is_teacher = request.POST.get("is_teacher") == "on"
1162+
"""Set the user type (teacher/student) when they sign up.
1163+
1164+
For social signups (OAuth), is_teacher defaults to False since
1165+
the OAuth flow doesn't collect this field.
1166+
"""
1167+
is_teacher = request.POST.get("is_teacher") == "on" if request else False
11641168
profile = user.profile
11651169
profile.is_teacher = is_teacher
11661170
profile.save()

web/settings.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,9 @@
142142
"channels",
143143
"allauth",
144144
"allauth.account",
145+
"allauth.socialaccount",
146+
"allauth.socialaccount.providers.google",
147+
"allauth.socialaccount.providers.github",
145148
"captcha",
146149
"markdownx",
147150
"web",
@@ -305,6 +308,35 @@
305308
"login": "web.forms.CustomLoginForm",
306309
}
307310

311+
# Social account settings
312+
SOCIALACCOUNT_AUTO_SIGNUP = True
313+
SOCIALACCOUNT_EMAIL_AUTHENTICATION = True
314+
SOCIALACCOUNT_EMAIL_AUTHENTICATION_AUTO_CONNECT = True
315+
SOCIALACCOUNT_EMAIL_VERIFICATION = "none" # Google/GitHub already verify emails
316+
SOCIALACCOUNT_ADAPTER = "web.adapters.CustomSocialAccountAdapter"
317+
SOCIALACCOUNT_LOGIN_ON_GET = True
318+
319+
# OAuth provider configuration
320+
SOCIALACCOUNT_PROVIDERS = {
321+
"google": {
322+
"APP": {
323+
"client_id": env.str("GOOGLE_OAUTH_CLIENT_ID", default=""),
324+
"secret": env.str("GOOGLE_OAUTH_CLIENT_SECRET", default=""),
325+
},
326+
"SCOPE": ["profile", "email"],
327+
"AUTH_PARAMS": {"access_type": "online"},
328+
"VERIFIED_EMAIL": True,
329+
},
330+
"github": {
331+
"APP": {
332+
"client_id": env.str("GITHUB_OAUTH_CLIENT_ID", default=""),
333+
"secret": env.str("GITHUB_OAUTH_CLIENT_SECRET", default=""),
334+
},
335+
"SCOPE": ["user:email"],
336+
"VERIFIED_EMAIL": True,
337+
},
338+
}
339+
308340
LANGUAGE_CODE = "en"
309341

310342
TIME_ZONE = "UTC"

web/templates/account/login.html

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
{% load static %}
44
{% load account %}
5+
{% load socialaccount %}
56

67
{% block extra_head %}
78
{{ block.super }}
@@ -16,6 +17,47 @@ <h2 class="mt-10 text-center text-2xl font-bold leading-9 tracking-tight text-gr
1617
</h2>
1718
</div>
1819
<div class="mt-10 sm:mx-auto sm:w-full sm:max-w-md">
20+
<!-- Social Login Buttons -->
21+
{% get_providers as socialaccount_providers %}
22+
{% if socialaccount_providers %}
23+
<div class="space-y-3 mb-6">
24+
<p class="text-center text-sm font-medium text-gray-500 dark:text-gray-400">Continue with</p>
25+
<div class="grid grid-cols-2 gap-3">
26+
{% for provider in socialaccount_providers %}
27+
{% if provider.id == "google" %}
28+
<a href="{% provider_login_url provider.id process='login' %}"
29+
class="flex items-center justify-center gap-2 rounded-lg border border-gray-300 dark:border-gray-600 bg-white dark:bg-gray-700 px-4 py-2.5 text-sm font-medium text-gray-700 dark:text-gray-200 shadow-sm hover:bg-gray-50 dark:hover:bg-gray-600 transition duration-200 focus:outline-none focus:ring-2 focus:ring-orange-500 focus:ring-offset-2">
30+
<svg class="h-5 w-5" viewBox="0 0 24 24">
31+
<path d="M22.56 12.25c0-.78-.07-1.53-.2-2.25H12v4.26h5.92a5.06 5.06 0 0 1-2.2 3.32v2.77h3.57c2.08-1.92 3.28-4.74 3.28-8.1z" fill="#4285F4" />
32+
<path d="M12 23c2.97 0 5.46-.98 7.28-2.66l-3.57-2.77c-.98.66-2.23 1.06-3.71 1.06-2.86 0-5.29-1.93-6.16-4.53H2.18v2.84C3.99 20.53 7.7 23 12 23z" fill="#34A853" />
33+
<path d="M5.84 14.09c-.22-.66-.35-1.36-.35-2.09s.13-1.43.35-2.09V7.07H2.18C1.43 8.55 1 10.22 1 12s.43 3.45 1.18 4.93l2.85-2.22.81-.62z" fill="#FBBC05" />
34+
<path d="M12 5.38c1.62 0 3.06.56 4.21 1.64l3.15-3.15C17.45 2.09 14.97 1 12 1 7.7 1 3.99 3.47 2.18 7.07l3.66 2.84c.87-2.6 3.3-4.53 6.16-4.53z" fill="#EA4335" />
35+
</svg>
36+
Google
37+
</a>
38+
{% endif %}
39+
{% if provider.id == "github" %}
40+
<a href="{% provider_login_url provider.id process='login' %}"
41+
class="flex items-center justify-center gap-2 rounded-lg border border-gray-300 dark:border-gray-600 bg-gray-900 dark:bg-gray-800 px-4 py-2.5 text-sm font-medium text-white shadow-sm hover:bg-gray-800 dark:hover:bg-gray-700 transition duration-200 focus:outline-none focus:ring-2 focus:ring-orange-500 focus:ring-offset-2">
42+
<svg class="h-5 w-5" fill="currentColor" viewBox="0 0 24 24">
43+
<path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839 9.504.5.092.682-.217.682-.483 0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608 1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088 2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951 0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65 0 0 .84-.27 2.75 1.026A9.564 9.564 0 0 1 12 6.844a9.59 9.59 0 0 1 2.504.337c1.909-1.296 2.747-1.027 2.747-1.027.546 1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028 2.688 0 3.848-2.339 4.695-4.566 4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012 2.747 0 .268.18.58.688.482A10.02 10.02 0 0 0 22 12.017C22 6.484 17.522 2 12 2z" clip-rule="evenodd" />
44+
</svg>
45+
GitHub
46+
</a>
47+
{% endif %}
48+
{% endfor %}
49+
</div>
50+
</div>
51+
<!-- Divider -->
52+
<div class="relative mb-6">
53+
<div class="absolute inset-0 flex items-center">
54+
<div class="w-full border-t border-gray-300 dark:border-gray-600"></div>
55+
</div>
56+
<div class="relative flex justify-center text-sm">
57+
<span class="bg-white dark:bg-gray-800 px-4 text-gray-500 dark:text-gray-400">Or sign in with email</span>
58+
</div>
59+
</div>
60+
{% endif %}
1961
<form class="space-y-6" action="{% url 'account_login' %}" method="post">
2062
{% csrf_token %}
2163
{% if form.errors %}

web/templates/account/signup.html

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{% extends "allauth/layouts/base.html" %}
22

33
{% load static %}
4+
{% load socialaccount %}
45

56
{% block extra_head %}
67
{{ block.super }}
@@ -24,6 +25,40 @@
2425
<div class="flex flex-col items-center space-y-3">
2526
<i class="fas fa-graduation-cap text-7xl text-orange-500"></i>
2627
<div class="text-lg font-medium text-gray-600 dark:text-gray-300">Join our community of learners and teachers</div>
28+
<!-- Social Sign Up Section on Left -->
29+
{% get_providers as socialaccount_providers %}
30+
{% if socialaccount_providers %}
31+
<div class="w-full max-w-xs mx-auto mt-6 space-y-3">
32+
<p class="text-sm font-medium text-gray-500 dark:text-gray-400">Quick sign up with</p>
33+
{% for provider in socialaccount_providers %}
34+
{% if provider.id == "google" %}
35+
<a href="{% provider_login_url provider.id process='login' %}"
36+
class="flex items-center justify-center gap-3 w-full rounded-lg border border-gray-300 dark:border-gray-600 bg-white dark:bg-gray-700 px-4 py-3 text-sm font-medium text-gray-700 dark:text-gray-200 shadow-sm hover:bg-gray-50 dark:hover:bg-gray-600 transition duration-200 focus:outline-none focus:ring-2 focus:ring-orange-500 focus:ring-offset-2">
37+
<svg class="h-5 w-5" viewBox="0 0 24 24">
38+
<path d="M22.56 12.25c0-.78-.07-1.53-.2-2.25H12v4.26h5.92a5.06 5.06 0 0 1-2.2 3.32v2.77h3.57c2.08-1.92 3.28-4.74 3.28-8.1z" fill="#4285F4" />
39+
<path d="M12 23c2.97 0 5.46-.98 7.28-2.66l-3.57-2.77c-.98.66-2.23 1.06-3.71 1.06-2.86 0-5.29-1.93-6.16-4.53H2.18v2.84C3.99 20.53 7.7 23 12 23z" fill="#34A853" />
40+
<path d="M5.84 14.09c-.22-.66-.35-1.36-.35-2.09s.13-1.43.35-2.09V7.07H2.18C1.43 8.55 1 10.22 1 12s.43 3.45 1.18 4.93l2.85-2.22.81-.62z" fill="#FBBC05" />
41+
<path d="M12 5.38c1.62 0 3.06.56 4.21 1.64l3.15-3.15C17.45 2.09 14.97 1 12 1 7.7 1 3.99 3.47 2.18 7.07l3.66 2.84c.87-2.6 3.3-4.53 6.16-4.53z" fill="#EA4335" />
42+
</svg>
43+
Sign up with Google
44+
</a>
45+
{% endif %}
46+
{% if provider.id == "github" %}
47+
<a href="{% provider_login_url provider.id process='login' %}"
48+
class="flex items-center justify-center gap-3 w-full rounded-lg border border-gray-300 dark:border-gray-600 bg-gray-900 dark:bg-gray-800 px-4 py-3 text-sm font-medium text-white shadow-sm hover:bg-gray-800 dark:hover:bg-gray-700 transition duration-200 focus:outline-none focus:ring-2 focus:ring-orange-500 focus:ring-offset-2">
49+
<svg class="h-5 w-5" fill="currentColor" viewBox="0 0 24 24">
50+
<path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839 9.504.5.092.682-.217.682-.483 0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608 1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088 2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951 0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65 0 0 .84-.27 2.75 1.026A9.564 9.564 0 0 1 12 6.844a9.59 9.59 0 0 1 2.504.337c1.909-1.296 2.747-1.027 2.747-1.027.546 1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028 2.688 0 3.848-2.339 4.695-4.566 4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012 2.747 0 .268.18.58.688.482A10.02 10.02 0 0 0 22 12.017C22 6.484 17.522 2 12 2z" clip-rule="evenodd" />
51+
</svg>
52+
Sign up with GitHub
53+
</a>
54+
{% endif %}
55+
{% endfor %}
56+
<p class="text-xs text-gray-400 dark:text-gray-500 text-center mt-2">
57+
<i class="fas fa-shield-alt mr-1"></i>
58+
No extra passwords to remember
59+
</p>
60+
</div>
61+
{% endif %}
2762
</div>
2863
</div>
2964
<!-- Form section -->
@@ -34,6 +69,46 @@ <h2 class="text-xl font-bold text-gray-900 dark:text-white flex items-center jus
3469
Create Account
3570
</h2>
3671
</div>
72+
<!-- Mobile-only social buttons -->
73+
{% get_providers as socialaccount_providers %}
74+
{% if socialaccount_providers %}
75+
<div class="md:hidden space-y-3 mb-4">
76+
<div class="grid grid-cols-2 gap-3">
77+
{% for provider in socialaccount_providers %}
78+
{% if provider.id == "google" %}
79+
<a href="{% provider_login_url provider.id process='login' %}"
80+
class="flex items-center justify-center gap-2 rounded-lg border border-gray-300 dark:border-gray-600 bg-white dark:bg-gray-700 px-3 py-2.5 text-sm font-medium text-gray-700 dark:text-gray-200 shadow-sm hover:bg-gray-50 dark:hover:bg-gray-600 transition duration-200">
81+
<svg class="h-4 w-4" viewBox="0 0 24 24">
82+
<path d="M22.56 12.25c0-.78-.07-1.53-.2-2.25H12v4.26h5.92a5.06 5.06 0 0 1-2.2 3.32v2.77h3.57c2.08-1.92 3.28-4.74 3.28-8.1z" fill="#4285F4" />
83+
<path d="M12 23c2.97 0 5.46-.98 7.28-2.66l-3.57-2.77c-.98.66-2.23 1.06-3.71 1.06-2.86 0-5.29-1.93-6.16-4.53H2.18v2.84C3.99 20.53 7.7 23 12 23z" fill="#34A853" />
84+
<path d="M5.84 14.09c-.22-.66-.35-1.36-.35-2.09s.13-1.43.35-2.09V7.07H2.18C1.43 8.55 1 10.22 1 12s.43 3.45 1.18 4.93l2.85-2.22.81-.62z" fill="#FBBC05" />
85+
<path d="M12 5.38c1.62 0 3.06.56 4.21 1.64l3.15-3.15C17.45 2.09 14.97 1 12 1 7.7 1 3.99 3.47 2.18 7.07l3.66 2.84c.87-2.6 3.3-4.53 6.16-4.53z" fill="#EA4335" />
86+
</svg>
87+
Google
88+
</a>
89+
{% endif %}
90+
{% if provider.id == "github" %}
91+
<a href="{% provider_login_url provider.id process='login' %}"
92+
class="flex items-center justify-center gap-2 rounded-lg border border-gray-300 dark:border-gray-600 bg-gray-900 dark:bg-gray-800 px-3 py-2.5 text-sm font-medium text-white shadow-sm hover:bg-gray-800 dark:hover:bg-gray-700 transition duration-200">
93+
<svg class="h-4 w-4" fill="currentColor" viewBox="0 0 24 24">
94+
<path fill-rule="evenodd" d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839 9.504.5.092.682-.217.682-.483 0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608 1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088 2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951 0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65 0 0 .84-.27 2.75 1.026A9.564 9.564 0 0 1 12 6.844a9.59 9.59 0 0 1 2.504.337c1.909-1.296 2.747-1.027 2.747-1.027.546 1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028 2.688 0 3.848-2.339 4.695-4.566 4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012 2.747 0 .268.18.58.688.482A10.02 10.02 0 0 0 22 12.017C22 6.484 17.522 2 12 2z" clip-rule="evenodd" />
95+
</svg>
96+
GitHub
97+
</a>
98+
{% endif %}
99+
{% endfor %}
100+
</div>
101+
<!-- Divider -->
102+
<div class="relative">
103+
<div class="absolute inset-0 flex items-center">
104+
<div class="w-full border-t border-gray-300 dark:border-gray-600"></div>
105+
</div>
106+
<div class="relative flex justify-center text-xs">
107+
<span class="bg-white dark:bg-[#1f2937] px-3 text-gray-500 dark:text-gray-400">Or create account with email</span>
108+
</div>
109+
</div>
110+
</div>
111+
{% endif %}
37112
<form id="signup_form"
38113
method="post"
39114
action="{% url 'account_signup' %}"

0 commit comments

Comments
 (0)