Skip to content
This repository

Help center for community-driven websites

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 backcap
Octocat-spinner-32 .gitignore
Octocat-spinner-32 AUTHORS
Octocat-spinner-32 COPYING
Octocat-spinner-32 MANIFEST.in
Octocat-spinner-32 README.rst
Octocat-spinner-32 requirements.txt
Octocat-spinner-32 setup.py
README.rst

Backcap

Backcap (Am.), to do one an ill-turn by speaking evil of him or carrying tales, or otherwise to "spoil his game."

And that's what your users are going to do with you ! ;-)

What is backcap ?

Backcap is a community-driven support module for any website.

Users can post ideas, problems and questions to your support team. People can vote for or against a feedback and you naturally see what's important for your community.

And if your community starts to grow, users car help each others.

In fact, that's something like an Help Center. And this is why we have developped it, to provides a smart help center for the websites we develop.

Features

For users

  • Post a feedback (from a plain page or a feedback tab) -- question, idea, problem
  • Browse and sort feedbacks
  • Vote for or against a feedback
  • Comment on a feedback
  • Follow a feedback

For the staff

  • Assign a feedback to someone
  • Set a state (Valid, Won't Fix, ...)
  • Close, reopen, mark as duplicate, ...

Notifications are handled using django-notification and can be indexed by haystack.

Requirements

Backcap requires:

  • django-notifications
  • django-voting

Backcap can make use of:

  • haystack (for feedback indexing)
  • south

Installation

  1. Add 'backcap' directory to your PYTHON_PATH

  2. Add backcap and its dependencies to your INSTALLED_APPS in settings.py:

    INSTALLED_APPS = (
           ...
           'notification',
           'voting',
           'backcap',
           ...
           )
    
  3. Add the context processor:

    TEMPLATE_CONTEXT_PROCESSORS = ("django.contrib.auth.context_processors.auth",
                                   ...
                                   'backcap.context_processors.backcap_forms',
                                   ...
                                   )
    
  4. Run syncdb and migrations:

    $ ./manage.py syncdb
    $ ./manage migrate backcap
    
  5. Add backcap to urls:

    urlpatterns = patterns('',
                           ...
                           url(r'^feedback/', include('backcap.urls')),
                           ...
                           )
    
  6. Write templates and you're done

Something went wrong with that request. Please try again.