Django Rating System

Here is a live demo

Installation
Configuration
Usage
Settings
- Global Settings
- Config Settings
Front-End
Live Demo

Installation

Install using pip

python -m pip install django-rating-system

or Clone the repository then copy rating folder and paste in project folder.

git clone https://github.com/mahyar-amiri/django-rating-system.git

Configuration

Add rating.apps.RatingConfig to installed_apps after django.contrib.auth in the settings.py file. Add MEDIA_URL and MEDIA_ROOT.

# setting.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

    # MY APPS
    'rating.apps.RatingConfig',
]

...

MEDIA_URL = '/media/'
MEDIA_ROOT = BASE_DIR / 'media'

Add path('rating/', include('rating.urls')), and media root to urlpatterns in the project urls.py file.

# urls.py

from django.urls import path, include
from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
     path('rating/', include('rating.urls')),
]

urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

Connect ratings to target model. In models.py add the field ratings as a GenericRelation field to the required model.

NOTE: Please note that the field name must be ratings NOT rating.

# models.py

from django.db import models
from django.contrib.contenttypes.fields import GenericRelation
from rating.models import Rating

class Article(models.Model):
    title = models.CharField(max_length=20)
    content = models.TextField()
    # the field name should be ratings
    ratings = GenericRelation(Rating)

Do migrations
```
python manage.py migrate
```

Usage

In the template (e.g. post_detail.html) add the following template tags where obj is the instance of post model.
```
{% load rating_tags %}
```
Add the following template tag to load stylesheet.
```
{% render_rating_import %}
```

Add the following template tags where you want to render ratings.

{% render_rating request obj settings_slug='default-config' %}  {# Render all the ratings belong to the passed object "obj" #}

if your context_object_name is not obj (e.g. article) replace obj with context_object_name.

{% render_rating request obj=article settings_slug='default-config' %}

Add the following template tag to show rating information.

{% render_rating_info request=request obj=article settings_slug='default-config' %}

use custom_template if you want to render your own template.

{% render_rating_info request=request obj=article settings_slug='default-config' custom_template='my_custom_rating_info.html' %}

Add render_rating_script tag at the end of the last render_rating tag.

{% render_rating_import %}

{% render_rating request=request obj=article settings_slug='default-config' %}
{% render_rating_info request=request obj=article settings_slug='default-config' %}

{% render_rating request=request obj=article settings_slug='like-config' %}
{% render_rating_info request=request obj=article settings_slug='like-config' custom_template='rating/rating_info.html' %}

{% render_rating_script %}

Settings

Global Settings

You can customize global settings by adding keywords to RATING_SETTINGS dictionary in project settings.py.

# setting.py
RATING_SETTINGS = {
    # generated urlhash length
    'URLHASH_LENGTH': 8
}

Config Settings

This settings can be configured in admin panel. Set your config in RatingSettings model. You can use multi config all at once.

FROM_ZERO = False  # if True, Rating will start from 0 otherwise 1
RATES = 5  # 1, 3, 5, 10
ICON  # path of rating icon
HEIGHT = '2rem'  # Height of icon with unit

Front-End

Templates Folder Tree

templates
   ├── rating
   │    ├── rating.html
   │    └── rating_info.html
   │
   ├── info
   │    ├── info_base.html
   │    └── info_extender.html
   │
   └── utils
        ├── IMPORTS.html
        └── SCRIPTS.html

Static Folder Tree

static
   ├── css
   │    ├── rating.css
   │    └── rating.min.css
   ├── img
   │    ├── heart.svg
   │    └── star.svg
   └── js
        ├── rating.js
        ├── rating.min.js
        └── jquery.min.js

mahyar-amiri/django-rating-system