Full Documentation
Content:
dab stands for Django-Ajax-Bootstrap PS: Ajax and JQuery are not used anymore since v2.0.0 Vanilla JS and fetch API is used instead.
django-comments-dab
is a commenting application for Django-powered websites.
It allows you to integrate commenting functionality with any model you have e.g. blogs, pictures, video etc…
List of actions that can be performed:
- Post a new comment. (v2.0.0 authenticated and anonymous users)
- Reply to an existing comment. (v2.0.0 authenticated and anonymous users)
- Edit a comment. (authenticated user comment owner)
- Delete a comment. (authenticated user comment owner and admins)
- React to a comment. (authenticated users) Available reactions are LIKE and DISLIKE # open PR if you would like to have more reactions
- Report (flag) a comment. (authenticated users)
- Delete flagged comment. (admins and moderators)
- Resolve or reject flag. This is used to revoke the flagged comment state (admins and moderators)
- All actions are done by Fetch API since V2.0.0
- Bootstrap 4.1.1 is used in comment templates for responsive design.
- django>=2.1
- djangorestframework # only for the API Framework
- Bootstrap 4.1.1
Installation is available via pip
$ pip install django-comments-dab
or via source on github
$ git clone https://github.com/radi85/Comment.git $ cd Comment $ python setup.py install
- Add
comment
to installed_apps in thesettings.py
file. It should be added afterdjango.contrib.auth
.LOGIN_URL
shall be defined in the settings.
settings.py
should look like this:
INSTALLED_APPS = (
'django.contrib.admin',
'django.contrib.auth',
...
'comment',
..
)
LOGIN_URL = 'login' # or actual url
In urls.py
:
urlpatterns = patterns(
path('admin/', admin.site.urls),
path('comment/', include('comment.urls')),
...
path('api/', include('comment.api.urls')), # only required for API Framework
...
)
Migrate comment app:
$ python manage.py migrate comment
In models.py add the field comments
as a GenericRelation
field to the required model.
PS: Please note that the field name must be comments
NOT comment
.
E.g. Post
model, as shown below:
from django.contrib.contenttypes.fields import GenericRelation
from comment.models import Comment
class Post(models.Model):
author = models.ForeignKey(User)
title = models.CharField(max_length=200)
body = models.TextField()
# the field name should be comments
comments = GenericRelation(Comment)
render_comments
tag uses 2 required and 1 optional args:
- Instance of the targeted model. (Required)
- Request object. (Required)
- oauth. (optional - Default is false)
include_bootstrap
tag is for bootstrap-4.1.1, if it’s already used in the project, get rid of this tag.
In the template (e.g. post_detail.) add the following template tags where obj
is the instance of post model.
{% load comment_tags %} {# Loading the template tag #}
{% render_comments obj request %} {# Render all the comments belong to the passed object "obj" #}
{% include_bootstrap %} {# Include bootstrap 4.1.1 - remove this line if BS is already used in your project #}
For advanced usage and other documentation, you may read the Documentation or look at the docs directory in the repository.
You can play with the example app using local virtual environment
$ git clone https://github.com/Radi85/Comment.git # or clone your forked repo
$ cd Comment
$ python3 -m venv local_env # or any name. local_env is in .gitignore
$ export DEBUG=True
$ source local_env/bin/activate
$ pip install -r test/example/requirements.txt
$ python manage.py migrate
$ python manage.py create_initial_data
$ python manage.py runserver
Or run with docker
$ git clone https://github.com/Radi85/Comment.git # or clone your forked repo
$ cd Comment
$ docker-compose up
Login with:
username:
test
password:
test
The icons are picked from Feather. Many thanks to them for the good work.
For contributing, please see the instructions at Contributing