Django User Profile

How to use it

$# Get the code$ git clone https://github.com/app-generator/sample-django-extended-user-profile.git$cd sample-django-extended-user-profile$$# Virtualenv modules installation (Unix based systems)$ virtualenv env$source env/bin/activate$$# Virtualenv modules installation (Windows based systems)$# virtualenv env$# .\env\Scripts\activate$$# Install modules - SQLite Storage$ pip3 install -r requirements.txt$$# Create tables$ python manage.py makemigrations$ python manage.py migrate$$# Start the application (development mode)$ python manage.py runserver# default port 8000$$# Start the app - custom port$# python manage.py runserver 0.0.0.0:<your_port>$$# Access the web app in browser: http://127.0.0.1:8000/

Codebase structure

< PROJECT ROOT>||-- core/# Implements app logic and serve the static assets||-- settings.py# Django app bootstrapper||-- static/|||--<css, JS, images># CSS files, Javascripts files||-- templates/# Templates used to render pages||||-- includes/# HTML chunks and components||-- layouts/# Master pages||-- accounts/# Authentication pages|||      index.html# The default page|*.html# All other HTML pages||-- authentication/# Handles auth routes (login and register)||-- urls.py# Define authentication routes||-- forms.py# Define auth forms||-- app/# A simple app that serve HTML files||-- views.py# Serve HTML pages for authenticated users||-- urls.py# Define some super simple routes||-- customers/# Handles the profile edit     <-------- NEW||-- __init__.py# Defines App init             <-------- NEW||-- admin.py# Defines App admin            <-------- NEW||-- apps.py# Defines App apps             <-------- NEW||-- forms.py# Defines App forms            <-------- NEW||-- models.py# Defines App models           <-------- NEW||-- signals.py# Defines App signals          <-------- NEW||-- tests.py# Defines App tests            <-------- NEW||-- urls.py# Defines App routes           <-------- NEW||-- views.py# Defines App views            <-------- NEW||-- requirements.txt# Development modules - SQLite storage|-- .env# Inject Configuration via Environment|-- manage.py# Start the app - Django default start script||--************************************************************************

User Profile Feature

Settings

Thecustomers app:

$ python manage.py startapp customers

TheProfile model

classProfile(models.Model):# Managed fieldsuser=models.OneToOneField(User,related_name="profile",on_delete=models.CASCADE)avatar=models.ImageField(upload_to="customers/profiles/avatars/",null=True,blank=True)birthday=models.DateField(null=True,blank=True)gender=models.PositiveSmallIntegerField(choices=GENDER_CHOICES,null=True,blank=True)phone=models.CharField(max_length=32,null=True,blank=True)address=models.CharField(max_length=255,null=True,blank=True)number=models.CharField(max_length=32,null=True,blank=True)city=models.CharField(max_length=50,null=True,blank=True)zip=models.CharField(max_length=30,null=True,blank=True)@propertydefget_avatar(self):returnself.avatar.urlifself.avatarelsestatic('assets/img/team/default-profile-picture.png')

TheProfile form

fromdjangoimportformsfromcustomers.modelsimportProfileclassProfileForm(forms.ModelForm):first_name=forms.CharField(max_length=255)last_name=forms.CharField(max_length=255)email=forms.EmailField()classMeta:model=Profilefields='__all__'exclude= ['user']defform_validation_error(form):"""    Form Validation Error    If any error happened in your form, this function returns the error message.    """msg=""forfieldinform:forerrorinfield.errors:msg+="%s: %s\\n"% (field.labelifhasattr(field,'label')else'Error',error)returnmsg

TheProfile view

fromdjango.contribimportmessages# import messages to show flash message in your pagefromcustomers.formsimportProfileForm,form_validation_error# import the used form and related function to show errorsfromcustomers.modelsimportProfile# import the Profile Model@method_decorator(login_required(login_url='login'),name='dispatch')classProfileView(View):profile=Nonedefdispatch(self,request,*args,**kwargs):self.profile,__=Profile.objects.get_or_create(user=request.user)returnsuper(ProfileView,self).dispatch(request,*args,**kwargs)defget(self,request):context= {'profile':self.profile}returnrender(request,'customers/profile.html',context)defpost(self,request):form=ProfileForm(request.POST,request.FILES,instance=self.profile)ifform.is_valid():profile=form.save()# to save user model infoprofile.user.first_name=form.cleaned_data.get('first_name')profile.user.last_name=form.cleaned_data.get('last_name')profile.user.email=form.cleaned_data.get('email')profile.user.save()messages.success(request,'Profile saved successfully')else:messages.error(request,form_validation_error(form))returnredirect('profile')

TheProfile HTML template

<formaction="{% url 'profile' %}"method="POST"enctype="multipart/form-data">        {% csrf_token %}<div><labelfor="first_name">First Name</label><inputname="first_name"class="form-control"id="first_name"type="text"placeholder="Enter your first name"value="{{ profile.user.first_name }}"required></div><div><labelfor="last_name">Last Name</label><inputname="last_name"class="form-control"id="last_name"type="text"placeholder="Also your last name"value="{{ profile.user.last_name }}"required></div><labelfor="gender">Gender</label><selectname="gender"class="form-select mb-0"id="gender"aria-label="Gender select example"><optionselected>Gender</option>            {% for key, value in profile.GENDER_CHOICES %}<optionvalue="{{ key }}"{%ifprofile.gender ==key%}selected{%endif%}>{{ value }}</option>            {% endfor %}</select><!-- And the rest of the fields --></form>

TheProfile routing

fromdjango.urlsimportpathfromcustomersimportviewsurlpatterns= [path('profile/',views.ProfileView.as_view(),name='profile'),]

fromdjango.confimportsettingsfromdjango.contribimportadminfromdjango.conf.urls.staticimportstaticfromdjango.urlsimportpath,includeurlpatterns= [path('admin/',admin.site.urls),# Django admin routepath('customers/',include("customers.urls")),# Django customers route# ...]# to support and show media & static files in developer modeifsettings.DEVEL:urlpatterns+=static(settings.MEDIA_URL,document_root=settings.MEDIA_ROOT)urlpatterns+=static(settings.STATIC_URL,document_root=settings.STATIC_ROOT)

Links & Resources