Demovox (dev readme)

Description

demovox is a tool to collect signatures for Swiss popular initiatives by offering the visitor a personalized signature sheet.

This Plugin was developed by the Socialist Party of Switzerland, it was initially built for the popular initiative Prämien-Entlastungs-Initiative.

Donations

If this plugin is of help for you, please consider a donation.

Requirements

PHP >= 7.0 (feature "Hashid" requires >= 7.1.3)
MySQL >= 5.6.5
WordPress >= 4.9
SSL certificate for HTTPS (unsecure connection is only allowed for development)
Optional feature requires the PHP modules "GMP" or "BC Math"

Installation (production)

Simply install the the WordPress plugin demovox from within the Plugin manager of your WordPress installation. You can find the admin manual or the prebuilt Zip-File for manual installation on demovox.ch.

Dev

Please send a pull request for any improvements on the plugin.

Installation

Pull demovox from within the Wordpress Plugin directory (/wp-content/plugins/)
Activate the plugin through the 'Plugins' menu in WordPress
Configure the plugin in WordPress admin
Place shortcodes [demovox_form] on a page
Optionally use and [demovox_count] to get the number of collected signatures and [demovox_optin] for the opt-in form.

Required packages

Please install the following build dependencies:

Python
Ruby
node.js (tested with v8.10.0)
composer
gettext

Download required packages:

npm install
npm install grunt-cli sass -g
composer install --no-dev

Generate assets

Generate minified JS and CSS files and compile .mo translation files:

grunt buildAssets

Build zip

Create a ZIP which can be uploaded to a remote WordPress installation:

grunt buildZip

Required packages for tests

composer install
bin/install-wp-tests.sh  <db-name> <db-user> <db-pass> [db-host]

Running the tests

There are just a few PHPUnit tests available yet, feel free to contribute some and send a pull-request to increase the test coverage.

grunt test

Unencrypted access

As a developer you might want to work on a web server without SSL configured. Enable WP_DEBUG in wp-config.php. Then open the Advanced settings of the plugin in the WordPress backend and disable "Redirect clients to secure HTTPS".

Changelog

See README.txt

Authors

See also the list of contributors who participated in this project. Thanks to @dbu for code review.

License

This project is licensed under the GPLv3 License - see the LICENSE.txt file for details.

benjaminpreiss / demovox Goto Github PK

demovox's Introduction