IdeaFeed

Standalone v2.0.0


IdeaFeed is a feedback system which allows for the collection of different feedback properties from live users through a customizable form based survey.

This system is an intent to collect useful information for further enhancement and stability of a website whether it be in beta or production level.

If you have any questions that are beyond the scope of this help file, please feel free to email mentioned above.

The requirements are simple:

  1. jQuery v1.7+
  2. PHP v5.2+
  3. MySQL v5+
IdeaFeed's ORM requires "mb_string" extension; most PHP distributions have this already so you may not have to worry.

After extraction of contents from the archive, follow these steps to install IdeaFeed:

PART I:
  1. Create a MySQL database (PostgreSQL coming soon)
  2. Upload the ideafeed directory to your website (location does not matter)
PART II:
  1. Point your favourite browser to the URL of the ideafeed directory (i.e. http://example.com/ideafeed/)
  2. First page will check for requirements, click "Proceed"
  3. Second page you will need to select the database you wish to use
  4. Third page you will enter the database connection information
  5. Fourth page you will create an admin account through which you can manage the entire IdeaFeed system
  6. If all goes well, you should now have completed the main portion of IdeaFeed's installation
See Tutorial Video: http://www.screenr.com/DvVH
 
Now, all that is left is to link to the JavaScript file from your website (i.e. index file, or header file). This is so that we can connect to IdeaFeed through your website's pages.
 
Example code to include at the <head> tag of your website file is below, make sure to correct the path to IdeaFeed's installation directory if required:
 
<script type="text/javascript" src="ideafeed/x/ideafeed.js"></script>
 
 
Once installed, setting up is very easy as everything is at your finger tips in the Administration panel
 
Administration:
  1. Point your favourite browser again to the URL of the ideafeed directory
  2. Login to administration with the admin account you created during installation
  3. Once logged in, click "Settings"
  4. You can now manage every aspect of IdeaFeed through this page
     
Remember that you MUST enable IdeaFeed in the administration panel to initiate IdeaFeed on your website

 

Administration

 

All the how to's below are to be done after logging into the admin panel.

How do I Enable/Disable the IdeaFeed system?

  1. Go to "Settings" -> "System Settings"
  2. Set the field "Enabled" to the choice you wish.
     

How do I set which pages to display the IdeaFeed button?

  1. Go to "Settings" -> "System Settings"
  2. In the field "Pages Displayed" you can enter the file(s)/folder(s) to display on specifically or by using wildcards to do so.

Here are some examples:

Display on ALL pages:

Display only when when in the folder "user/" and in the folder "support/"


Display only when when in the folder "forum/" and in the file contact.php

 

How do I stop the IdeaFeed button from being displayed?

  1. Go to "Settings" -> "General Settings"
  2. Set the field "Insert Buttong on Page Load" to the value "No"
  3. See below for example:

 

How do I open the IdeaFeed modal from a link or an element?

Add a click event to your link/element and call the function below:

ideafeed.open();

For example, let's open using the example link: Click me to open!

<a href="#" onClick="javascript:ideafeed.open()">Click me to open!</a>

 

How do I open the IdeaFeed modal from a link or an element?

After ideafeed.js is loaded, use the following options to embed the modal into a container on your page:

<script type="text/javascript">
    ideafeed.options({
        auto_start  : false,  // Disable IdeaFeed from display button at bottom (optional)
        show_close  : false,  // Hide close button from modal (optional)
        embedded    : true,   // Let IdeaFeed know it's about to be embedded (required)
        container   : '#box', // The id of the container you want to contain IdeaFeed within (required)
    });
</script>

List of features, as of the current version:
[General]
  • Multi-Language support (English, Spanish)
  • PHP5 and MySQL5 powered
  • Ajax powered
  • Built-in ORM (RedBeanPHP)
  • Built-in forum
  • Automated installation process (See Video: http://www.screenr.com/iOoH)
  • Ability to post replies
  • Ability to collect public vote (up or down)
  • Categories: Question, Idea, Compliment, and Problem
  • Secured admin panel (See administration features below)
  • Collective user system
  • User rating collection at end of new feed
  • A new implementation of color captcha 
  • Call IdeaFeed through custom element (See: How To)
  • Managment of the system with staff accounts, permission-based
  • Staff identified posting
  • File attachments
  • Single-Sign-On (Google)
  • Best Answers by voting up/down
  • Post editing
  • Email subscription
  • Take screenshot of webpage with user highlighting
  • Private posting and forced interaction between staff & author  
  • Subdomain feature w/Admin management
  • Post flagging system w/management
  • "Best Answer" & "Community's Choice" markers
  • Reply-to using hash/indicator
  • IdeaFeed modal embeddable on page
  • SSO Services (Google, Facebook, Windows Live, Mail.ru)
  • Emoticons
  • SEO Friendly
  • Fully Responsive
  • Theme customization
[Administration]
  • Extensive statistical information
  • Staff management system
  • Feed management system
  • Post management system
  • User management system
  • Enable or disable system (See: How To Enable/Disable)
  • Ability to control which pages to display feedback button (See: How To)
  • Easy language selection
  • SSO Management
  • Excel export
  • Control email notification of new feeds
  • Control automatic activation of feeds and posts
  • Control whether or not to automatically start IdeaFeed button
  • Configure start delay time
  • Configure screenshot option
  • Configure private posting option
  • Customize title of feedback modal
  • Customize button position
  • Customize button text
  • Customize button foreground & background colors
  • Customize button radius
  • Customize button's special border

 

v2.0.0 - 03/13/2014
  + SSO management system added in administration
  + Theme customization
  + SEO Friendly
  + Multi-manage users/feeds/posts
  + Export feeds to excel
  + Complete redesign
  + Fully-responsive layout
  + User/IP Ban system
  + Verification required after a free 3 votes per IP (controlled by admin)
  + Modal framework redesign
  - Several other little features and tweaks as well!
  - SSO Services fixed for cross-origin errors
  - Re-Calculate Statistics - Miscalculation with feed votes
  - Several other minor bugs fixed
v1.4.2 - 01/13/2014
  + Subdomain feature w/Admin management
  + Post flagging system w/management
  + "Best Answer" & "Community's Choice" post markers added
  + Reply-to using hash/indicator
  + SSO Services (Google, Facebook, Windows Live, Mail.ru)
  + Emoticons
  + IdeaFeed modal embeddable on page
  - Attachments to reply section
  - Configure bad words
  - Configure states
  - Minor additions and changes to administration
  - When referred from email, fetch & save user info from db
  - White screen in modal on first startup (and direct feed link)
v1.2.8 - 12/15/2013
  + Login using Google
  + File attachments
  + "Best Answer" system by vote up/down
  + Post editing with variable of 5 minutes
  + Automatic feed subscriptions
  + Emails to all subscribed along with unscription link
  - Status sorting
  - Bad words filter for all posts
  - Several minor changes and additions
  - White screen in modal on first startup
v1.1.9 - 12/06/2013
  + Allow managment of the system with staff accounts
  + Take screenshot of webpage with user highlighting
  + Post privately and force interaction only between staff & author
  + Detect logged in staff, post under staff, and skip validation/activation for staff
  - More specific controls for form features (screenshots, private posts)
  - Added customizable filters on feeds page
  - Added post time on feeds page
  - Several minor changes and additions
  - Several minor bug fixes
v1.1.0 - 11/29/2013
  + Added gravatars
  - Added feed count to each category
  - Choose language on the modal
  - Highlight author replies
  - Highlight admin replies
  - Proper feed display for posts
v1.0.7 - 11/23/2013
  + Manual initiation of IdeaFeed
  - Subcategorized settings
  - Control manual/automatic activation of feeds
  - Hide button on startup
  - Add time delay to show button
  - More advanced post management
v1.0.1 - 11/22/2013
  - Fixed hidden buttons in some browsers by adding a conditional scrollbar to new feed section
Credits to the following content used in the making of IdeaFeed:

 


As I said at the beginning, I'd be glad to help you if you have any questions relating to this script. No guarantees, but I'll do my best to assist. If you have a more general question relating to IdeaFeed, you might consider visiting the forums and asking your question in the "Item Discussion" section on CodeCanyon.

Regards,
Nadeem Syed (x3ns)

http://codecanyon.net/user/x3ns