zcrosby/site-feedback

Simple feedback form built with Flask

site-feedback

Embed a basic feedback form into a webapp.

Usage:

Requires Flask, postgres... See requirements.txt

1. Deploy Flask application.
2. If application is used outside of ProvPlan, disregard other recipients section in settings.
3. If application is used outside of ProvPlan, include your own email library. ...see issueForm.py.example
4. Run the included schema file issueTable.sql
5. Add embedFeedback.js to site and create FEEDBACK_FORM_URL var in your page with the url to the deployed Feedback app.
   • EX: ``` <script>FEEDBACK_FORM_URL="http://0.0.0.0:5000"</script>
     <script src="embedFeedback.js"></script>

6. You will need to create a dom element with the id site-feedback. This will enable the feedback form to open in a lightbox.
   • EX: <a href="#" id="site-feedback"><span>Send us Feedback</span></a>
   • EX: <a href="#" id="site-feedback"><img src="static/images/feedbackBtn.png" alt="feedback"></a>
7. Within settings.py you will need to add your specs to the database info.
8. In the same file adjust the TOPICS to populate the forms topic options with your own options.
   • EX: TOPICS = ( ("reference value for base.html", "option value in select tag"), ("...","..."), )
9. Set SMTP settings for email notifications to be sent to your email address. or configure settings file to work with your emailing library... see settings.py.example. Make sure to remove .example from file name for production.

site-feedback's Issues

console.log

There are a few console.log messages in base.js. This will break some browsers.

Error Feedback

When the form encounters an error, the app returns '''{status: "error"}'''. But the form doesn't display that its encountered an error. Users should be notified of the error.