Skip to content

renickbuettner/survey-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Renick.Survey

Just a simple OctoberCMS plugin for doing surveys on your website. These features are provided by the initial release of this plugin:

  • Create surveys with multiple options
  • Choose between single- and multiple-choice
  • Show results of a survey
  • Optionally get users details, e.g. for a raffle
  • Optionally get a notification email after each submit
  • Localized in German and English
  • Fully customizable via Twig templates
  • Fully customizable via CSS
  • Simple Spam Protection

The plugin is built without own CSS, or Javascript dependencies. The component twig layout is built with Bootstrap 5 classnames. If you do not have Bootstrap 5 in-place, please just add your own CSS.

How to use

Just install the plugin and add the component to your page. Create a survey and add some options. Then select the survey in the component settings and you are done.

It may is needed to add some own css rules to your theme to make it look nice for your template. The component is built with Bootstrap 5 classnames.

The notification email is optional, and enables notifications for a survey.

Technical notice

Also there are environment variables which may are handy:

# limit the number of surveys per IP address (limit per survey)
SURVEY_IP_ADDRESS_LIMIT=99

#  enable, disable using a cookie to prevent double answers
SURVEY_COOKIE_LIMIT=false

# disable all email notifications (may temporarily)
SURVEY_DISABLE_EMAIL_NOTIFICATIONS=true

Found a bug?

Feel free to open an issue on GitHub, suggest a pull-request or reach out to me using the contact form on my homepage.