README.md

BaseApp Reactions

Reusable app to enable User's reactions on any model, features like like/dislike or any other reactions type, customizable for project's needs.

How to install:

Add dependencies to your requirements/base.txt file:

baseapp-core @ git+https://github.com/silverlogic/baseapp-backend.git@v0.1#subdirectory=baseapp-core
baseapp-reactions @ git+https://github.com/silverlogic/baseapp-backend.git@v0.1#subdirectory=baseapp-reactions

And run provision or manually pip install -r requirements/base.ext

If you want to develop, install using this other guide.

How to use

Add baseapp_reactions to your project's INSTALLED_APPS

Now make sure all models you'd like to get reactions also inherits ReactableModel, like:

from baseapp_reactions.models import ReactableModel

class Comment(models.Model, ReactableModel):
    body = models.Textfield()

Also make sure your GraphQL object types extends ReactionsNode interface:

from baseapp_reactions.graphql.object_types import ReactionsNode

class CommentNode(DjangoObjectType):
    class Meta:
        interfaces = (relay.Node, ReactionsNode)

Expose ReactionsMutations and ReactionsQuery in your GraphQL/graphene endpoint, like:

from baseapp_reactions.graphql.mutations import ReactionsMutations
from baseapp_reactions.graphql.queries import ReactionsQuery

class Query(graphene.ObjectType, ReactionsQuery):
    pass

class Mutation(graphene.ObjectType, ReactionsMutations):
    pass

schema = graphene.Schema(query=Query, mutation=Mutation)

This will expose reactionToggle mutation and add fields and connections to all your GraphqlQL Object Types using interface ReactionsNode.

Example:

{
    comment(id: $id) {
        id
        reactionsCount {
            LIKE
            DISLIKE
            total
        }
        reactions(first: 10) {
            edges {
                node {
                    reactionType
                    user {
                        name
                    }
                }
            }
        }
    }
}

How to to customize the Reaction model

In some cases you may need to extend Reaction model, and we can do it following the next steps:

Start by creating a barebones django app:

mkdir my_project/reactions
touch my_project/reactions/__init__.py
touch my_project/reactions/models.py

Your models.py will look something like this:

from django.db import models
from django.utils.translation import gettext_lazy as _

from baseapp_reactions.models import AbstractBaseReaction

class Reaction(AbstractBaseReaction):
    custom_field = models.CharField(null=True)

    class ReactionTypes(models.IntegerChoices):
        LIKE = 1, _("like")
        DISLIKE = -1, _("dislike")

        @property
        def description(self):
            return self.label

Now make your to add your new app to your INSTALLED_APPS and run makemigrations and migrate like any normal django app.

Now in your settings/base.py make sure to tell baseapp-reactions what is your custom model for Reaction:

BASEAPP_REACTIONS_REACTION_MODEL = 'reactions.Reaction'

Writing test cases in your project

There is a AbstractReactionFactory which helps you write other factories:

import factory
from baseapp_reactions.tests.factories import AbstractReactionFactory

class CommentFactory(factory.django.DjangoModelFactory):
    class Meta:
        model = "comments.Comment"


class CommentReactionFactory(AbstractReactionFactory):
    target = factory.SubFactory(CommentFactory)

    class Meta:
        model = "baseapp_reactions.Reaction"
        # OR if you have a custom model, point to it:
        model = "reactions.Reaction"

In the above example we have a easy way to make reactions to any comment into the database for testing proporses using CommentReactionFactory.

How to delevop

Clone the project inside your project's backend dir:

git clone git@github.com:silverlogic/baseapp-backend.git

And manually install the package:

pip install -e baseapp-backend/baseapp-reactions

The -e flag will make it like any change you make in the cloned repo files will effect into the project.