Installation Guide

Follow these steps to install and set up django-referral-system:

Supported Python versions: 3.9, 3.10, 3.11, 3.12, 3.13, and 3.14.

  1. Install the package via pip:

    pip install django-referral-system
    
  2. Add referrals to your INSTALLED_APPS in settings.py:

    INSTALLED_APPS = [
        # other apps
        'referrals',
    ]
    
  3. Add to urls.py:

    from django.urls import path, include
    
    urlpatterns = [
        # Other URL patterns...
        path('referrals/', include("referrals.urls")),
    ]
    
  4. Apply Migrations:

    python manage.py migrate