Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dreidev/scarlet
https://github.com/dreidev/scarlet
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dreidev/scarlet
- Owner: dreidev
- Created: 2015-08-26T13:31:12.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-12T10:07:09.000Z (almost 9 years ago)
- Last Synced: 2023-03-03T16:46:18.416Z (almost 2 years ago)
- Language: Python
- Size: 235 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#`django-ajax-favorite-like` Scarlet
`django-ajax-favorite-like` is a favoriting/liking application for Django-powered websites.
It gives you the ability integrate favoriting functionality to any model you have eg. blogs, pictures, etc..
In addition, related functionalities like thumbs up, vote, like, follow are also supported.
####All actions are ajax supported.
##Installation
Installation is available via `pip`
`$ pip install django-ajax-favorite-like`
or via source on github
```
$ git clone https://github.com/dreidev/Scarlet.git
$ cd Scarlet
$ python setup.py install
```
Add 'fav' to your installed_apps in your `settings.py` file. It should look like the following. Note that you should add it after `django.contrib.auth`:
```python
INSTALLED_APPS = (
'django.contrib.admin',
'django.contrib.auth',
...
'fav',
..
)
```
In your urls.py:
```python
urlpatterns = patterns('',
...
url(r'^fav/', include('fav.urls')),
...
)
```
##Migrations for Django 1.7 and later
migrate app models
```python
python manage.py migrate
```
##Setup
###Step 1
In your models.py add the field favorites to the model for which favorite functionality should be added (e.g. Blog) and the appropriate imports as shown below
```python
from django.contrib.contenttypes.fields import GenericRelation
from fav.models import Favorite
class Blog(models.Model):
author = models.ForeignKey(User)
title = models.CharField(max_length=256)
body = models.TextField()
favorites = GenericRelation(Favorite)
```
###Step 2
In your template (e.g. blog-detail.html) add the following template tags where object is the instance of blog.
```python
{% load favorite_tags %}
{% get_fav_count object %}
{% if user.is_authenticated %}
{% get_fav object user %}
{% else %}
{% get_fav_nouser object request %}
{% endif %}
```
This requires jQuery. If you're not already including it, we have a template tag that you can include in your html.
It should be added after `{% load favorite_tags %}` directly
```python
{% load favorite_tags %}
{% include_jQuery %}
```
Also static files should be added for ajax to work
```python
{% load static %}
```
##Settings
In `settings.py` we only need to indicate which notations we would be using in our application. Wether it's favorite, like, vote, thumbs up, follow .. etc
```python
#for example ..
POSITIVE_NOTATION = "Favorite"
NEGATIVE_NOTATION = "Unfavorite"
```
or alternatively
```python
#for example ..
POSITIVE_NOTATION = "Follow"
NEGATIVE_NOTATION = "Unfollow"
```
###ALLOW_ANONYMOUS
By default anonymous users are allowed to use the app's functionality. However, you can change that by setting ALLOW_ANONYMOUS to FALSE.
In `settings.py` ..
```python
ALLOW_ANONYMOUS = "FALSE"
```
###DEFAULT
Default values are
```python
#for example ..
POSITIVE_NOTATION = "Favorite"
NEGATIVE_NOTATION = "Unfavorite"
ALLOW_ANONYMOUS = "TRUE"
```