This repository contains Online shop plugins to collect donations for the non-profit organization WWF Germany. Display banners and sending mail reports. At this moment there are three plugins for WooCommerce, Shopware version 5 and 6.
NOTE: Currently all these plugins are in German language available only.
Do you have questions, want to request a feature or did you find a bug? -> Create issues!
This README will give you some high-level ideas of the shop plugins, for shop-specific information have a look at the subdirectories wp and shopware.
- Five donation campaigns are supported officially
- Providing banner content in two variants (small and normal) for an easy integration into your shop's content.
- Campaign reporting
- Automatic generation of donation reports in the following time ranges: weekly, monthly, quarterly
- Automatic mail delivery of donation report content to WWF Germany
- Reports are persisted and transparently accessible in custom backend section
- Custom "live" report preview
- No impact on privacy of customers by using this plugin
- PHP 7.4+
- MySQL/MariaDB 5.7+/10.3+
- Currency: Euro
- General tested minimum screen width:
320px - Maximum screen width:
4k+ - Main banner main class:
.cart-donation-banner - Small banner main class:
.cart-donation-mini-banner - SCSS base styles:
assets/styles/banner.scss - The shop software has to be capable of sending mails
This plugin supports five different donation campaigns:
- Protecting species
- Protecting oceans
- Protecting forests
- Protecting climate
- Protecting diversity
Have a look at the screenshots.
In general, you can configure three different report interval modes: weekly, monthly, quarterly.
Each report will be sent by mail to an email address you can view, but not change in the plugin's backend section.
Technically the report generation is a summation of plugin's donation products in completed or processed orders grouped by a donation campaign in a certain time range.
One time per day, a routine will check if the time to generate a new report has been reached. You can view the date and time of the last check in the plugin's report dashboard.
This plugin enables you to modify certain aspects of the donations campaign integration:
- Reporting interval: {weekly, monthly, quarterly}
- Report preview default days in the past: This can be overwritten in the preview section.
- (readonly) Recipient's mail address: You can't change this value and you must not.
- Show Mini-Banner in Mini-Cart:* yes/no flag.
- Campaign of mini-banner:* Default is "protect diversity"
- Target page of "more information" link in Mini-Banner:* Default is the "Cart page".
* If you change these settings, in order to see the effects, you need to clear your browser's cookies and the local
storage one time. E.g. by doing the following (in Chromium Browser):
Dev Tools -> Application -> Local Storage -> Delete the entry which is prefixed by 'wc_cart_hash...' and reload the page
.
There is a setup.sh to create a development environment for all plugins initially.
In addition, there is a release.sh to build the plugin's release archives.
Execute release.sh in this repository to get a production-ready distributable .zip-archive of the plugins.
To increase the plugin version, you have to change the version number in the following files:
wp/wwf-donations-plugin/wwf-donations-plugin.phpwp/wwf-donations-plugin/package.json+npm iwp/wwf-donations-plugin/composer.json+composer ucore/composer.json+composer u- Add changelog messages to the bottom of
wp/wwf-donations-plugin/readme.txt
- PHP Language Level 7.4+
- MySQL/MariaDB 5.7+/10.3+
docker+docker-compose- Composer for PHP
npm16+
All images in wp/wwf-donations-plugin/images/ are explicitly excluded of the licensing policy mentioned below.
This repository is licensed with GPL v3.0 or later.