tuvalabs / django-inapp-survey

In App Survey/Announcement for Django Application

django-inapp-survey

In App Survey/Announcement for Django Application

Inapp-Survey is a simple Django app to conduct Web-based In-App survey. For each question, user answers are saved. You can set the constraints by which the announcement/survey questionnarie is shown on specific page or specific users.

Quick start

1. Installation

   $ pip install django-inapp-survey

2. Add inapp_survey to your INSTALLED_APPS settings like this::

   INSTALLED_APPS = [
       ...
       'inapp_survey',
   ]

3. Include the inapp_survey URLconf in your project urls.py like this::

   url(r'^inapp_survey/', include('inapp_survey.urls')),

4. Run python manage.py migrate inapp_survey to create the campaign models.

5. Start the development server and visit http://127.0.0.1:8000/admin/ to create a survey (you'll need the Admin app enabled).

Usage

There are two types of campaign you can run -

1. Announcement - Plain informative announcment
2. Survey - It allows survey questionnaire, and expects each step as question

TODO: Markdown usage

TODO: Example screenshots

TODO: Hows custom_params works

TODO: Explain model fields for Campaign

django-inapp-survey's Issues

Style leaks on the template

On the different page, it inherits style from the page style. Style needs to be reviewed once and should be contained on those places.

Cancel campaign X icon is sometime not catching attention

Probably we can increase the size of the X sign.

z-index of the survey template should be higher

When the app page has intercom icon, it appears on top of the inapp survey template. It should have higher z-index than the intercom, or provide the way to handle it at the app level.

Question screen UI changes

@naveenkumarganesan @benfarahmand What do you guys think about below changes?

1. When you land on the question screen, the focus should be on the text area, textbox or the first checkbox/radio button.
2. Do we need the square around the question? for other types of questions it might work fine, but for a long question like below, it doesn't look that well. Can we try out without border box for all?
3. Submit button is all the way down, is it because of the height of the survey box?

Add View Count to Campaign Object

Please add the number of times a campaign has been viewed by users. This can be an additional column added to the Campaign Object in the Django admin interface.

Check on the In-App Campaign Timing

After the user signs up or signs in please wait 5 minutes before showing the first campaign.

Subsequent campaigns should also wait at least 5 minutes.

Image should not be clickable.

Because of the markdown editor's functionality, image hover shows magnifying glass. It should not allow that.