Empathy App is a Wordpress plugin that is integrated into websites with the help of Wordpress shortcodes.
This document gives a technical overview. For more technical details please investigate the docs/ and in particular docs/intro, as well as the source code itself.
Installed as a WP plugin (download the .zip and use it as the installation file). Plugin dependencies and shortcodes to use are described under the headings below.
- LAMP
- Wordpress (we can think of Wordpress as an application platform)
Also relies on this WP plugin:
- Neat Skype status v2/pro link
| Internal name | Wordpress role | Username restrictions |
|---|---|---|
| Empathizer | contributor | empathizer_{first-name}, is both WP username and also an existing Skype name |
| Caller | subscriber | Is both WP username and also an existing Skype name |
| Administrator | administrator | Any valid WP login name |
The website using EmpathyApp needs to have five pages with different shortcodes. PHP code (and JS, HTML) is inserted through shortcodes.
A graphical overview in two parts: before call and after call.
- Example
- Caller perspective: Place to make calls from
- Shortcode 1: [ea_skype_page]
- Shortcode 2 (from Neat skype status): [skype skypenames="skypename1, skypename2, ..."] Example: [skype skypenames="echo123, tord_dellsen, infinitytaal"]
- Plugin dependencies: Neat Skype status v2 (pro) please note that "pro" version is required
- How it works: Clicking the icon will call one of the people in the list of Skype names. Our shortcode limits access to users who are logged in
- Used by: Caller
- Example
- Empathizer perspective: Form for filling in the user name of caller from just finished call and the length of the call, after submitting the form an email will be automatically sent to the caller
- Dev perspective: The actual sending of the email is done on the next page below
- Shortcode: [ea_email_form]
- How it works: While logged in as an empathizer (currently using the administrator role), entering a user name for a caller (currently using the subscriber role) and number of minutes for preceding call and pressing button will send an email to the caller with a link to the donation form
- Used by: Empathizer
- File: pages/email-form_sc.php
- Example
- Empathizer perspective: Verification that the email has been sent to the caller
- Dev perspective: Sends email and also stores call record in the database
- Shortcode: [ea_email_sent]
- Used by: Empathizer
- File: pages/email-sent_sc.php
- Example
- Caller perspective: Arrives at this page after clicking link received in an email (see previous step)
- Shortcode: [ea_donation_form]
- For testing, use 4242 4242 4242 4242 as the credit card number and anything for the other fields. We are using a test key so you can test all you want without any real money being transfered. To verify that the transfer was made you need access to the Empathy App stripe account but we also print the result and the amount transfered on the "thank you" page
- Used by: Caller
- File: pages/donation_form_sc.php
- Example
- Dev perspective: Makes the actual charge of the credit card
- Shortcode: [ea_donation_sent]
- Plugin dependencies: P2P WP plugin
- Used by: Caller
- File: pages/donation_sent_sc.php