A small web service that allows you to embed a web form within your web application, which forwards the content of the web form to a slack chat room of your dev team.
First go over to slack and set up a chat room for your team if you already do not have one. Then setup a room called, e.g. '#feedback'. Then, you will want to set up 'Incoming WebHooks', such that you get a URL end point for the room '#feedback'.
Second, you will need to get a secret key for the Google recaptcha to work. Go over to Google and get one.
Create a local_config.py
file for which you should add the following configuration values:
- FEEDBACK_SLACK_END_POINT = 'Enter your slack WebHook Integration end point'
- GOOGLE_RECAPTCHA_PRIVATE_KEY = 'Enter your recaptcha key'
Note you should not add this to your git repo, and only if you ignore the git-ignore, will you do so.
You can start the application in the following way:
python wsgi.py
Visit the web page index.html
and fill out the feedback form:
Press submit, and you will see the following message arrive within your slack chat room:
You can replace the name, posting channel, and emoji of the bot that posts in your chatroom by replacing the two keywords:
- SLACKBACK_USERNAME
- SLACKBACK_CHANNEL
- SLACKBACK_EMOJI
You can find a selection of possible emojis on this cheat sheet.
A Vagrantfile and puppet manifest are available for development within a virtual machine. To use the vagrant VM defined here you will need to in stall Vagrant and VirtualBox.
To load and enter the VM: vagrant up && vagrant ssh
.