Democratizing Generosity - The best way to accept donations on WordPress
ravinderk Merge pull request #3771 from impress-org/issue/3768
fix: pass donor comment content to Akismet api request when doing spam validation #3768
Latest commit fbc1b3d Oct 15, 2018
Permalink
Failed to load latest commit information.
.github chore: simplify language in Bug Type section Sep 27, 2018
assets/src fix: load gateway only after nonce reset after donor login Oct 12, 2018
blocks fix: access Give_Donor_Wall class object with get_instance Sep 18, 2018
includes Merge pull request #3771 from impress-org/issue/3768 Oct 15, 2018
languages chore: run npm prod Oct 12, 2018
sample-data tests: Add 2 Frontend UI tests Sep 10, 2018
templates fix: add backward compatibility in donor wall template for comment Sep 13, 2018
tests Merge branch 'release/2.3.0' into issue/3627 Sep 14, 2018
.babelrc Added some sample block stuff Jan 16, 2018
.editorconfig 1. Removing old bower and other unneeded files Dec 27, 2017
.eslintignore Ignore node_module folder for eslint Jan 15, 2018
.eslintrc Fix lint errors for blocks Aug 21, 2018
.gitattributes New .gitattributes file export ignore file - brought over from Woo Apr 10, 2017
.gitignore Removing yarn lock file Jan 10, 2018
.scrutinizer.yml Touched up scrutinizer file Aug 3, 2017
.travis.yml fix(tests): Remove phpmyadmin and wpcli docker containers Sep 4, 2018
CHANGELOG.md Updated changelog md Jan 31, 2018
CODE_OF_CONDUCT.md Added a CODE_OF_CONDUCT.md file in the spirit of WP and open source #339 Jan 10, 2018
CONTRIBUTING.md Fix grammatical mistakes Aug 22, 2017
README.md Fix local development link Aug 1, 2018
changelog.txt doc(update): move change log items and add upgrade notice section Apr 24, 2018
composer.json build(composer): Add script to copy files required by TCPDF Aug 2, 2018
composer.lock Merge branch 'master' into release/2.3.0 Sep 7, 2018
docker-compose.yml fix(tests): Remove phpmyadmin and wpcli docker containers Sep 4, 2018
give.php refactor: update links to repo and remove wordimpress from readme.txt Oct 12, 2018
license.txt Added givewp to the contributors list Nov 4, 2016
package-lock.json Merge branch 'master' into release/2.3.0 Sep 7, 2018
package.json Merge branch 'master' into release/2.3.0 Sep 7, 2018
phpcs.ruleset.xml New .gitattributes file export ignore file - brought over from Woo Apr 10, 2017
phpunit.xml Update include paths May 17, 2017
postcss.config.js CSS compiling but still issues remaining Jan 3, 2018
readme.txt refactor: update links to repo and remove wordimpress from readme.txt Oct 12, 2018
uninstall.php fix(session): remove session table on plugin uninstall Jun 20, 2018
webpack.config.js Remove 'lodash modules' and add lodash to externals Aug 21, 2018
wpml-config.xml Add WPML config file May 15, 2017

README.md

GiveWP

WordPress version WordPress Rating WordPress Downloads Build Status Code Coverage Scrutinizer Code Quality License

Welcome to the GiveWP GitHub repository. This is the code source and the center of active development. Here you can browse the source, look at open issues, and contribute to the project. We recommend all developers follow the GiveWP development blog to stay up to date on the latest features and changes.

Getting Started

If you're looking to contribute or actively develop on Give then skip ahead to the Local Development section below. The following is if you're looking to actively use the plugin on your WordPress site.

Minimum Requirements

  • WordPress 4.8 or greater
  • PHP version 7.0 or greater
  • MySQL version 5.6 or greater
  • Some payment gateways require fsockopen support (for IPN access)
  • cURL version 5.40 or higher
  • An SSL certificate -- while this is not strictly required, it is highly recommend. If you are converting your site to use SSL/HTTPS now, we have a detailed guide to help you here.

Automatic installation

Automatic installation is the easiest option as WordPress handles the file transfers itself and you don't need to leave your web browser. To do an automatic install of Give, log in to your WordPress dashboard, navigate to the Plugins menu and click "Add New".

In the search field type "Give" and click Search Plugins. Once you have found the plugin you can view details about it such as the point release, rating and description. Most importantly of course, you can install it by simply clicking "Install Now".

Manual installation

The manual installation method involves downloading our donation plugin and uploading it to your server via your favorite FTP application. The WordPress codex contains instructions on how to do this here.

Support

This repository is not suitable for support. Please don't use GitHub issues for support requests. To get support please use the following channels:

Local Development

To get started developing on the Give platform you will need to perform the following steps:

  1. Create a new WordPress site with give.test as the URL

  2. cd into your local plugins directory: /path/to/wp-content/plugins/

  3. Clone this repository from GitHub into your plugins directory: https://github.com/WordImpress/Give.git

  4. Run composer to set up dependancies: composer install

  5. Run npm install to get the necessary npm packages: npm install

  6. Activate the plugin in WordPress

That's it. You're now ready to start development.

NPM Commands

Give relies on several npm commands to get you started:

  • npm run watch - Live reloads JS and SASS files. Typically you'll run this command before you start development. It's necessary to build the JS/CSS however if you're working strictly within PHP it may not be necessary to run.
  • npm run dev - Runs a one time build for development. No production files are created.
  • npm run production - Builds the minified production files for release.

Development Notes

  • Ensure that you have SCRIPT_DEBUG enabled within your wp-config.php file. Here's a good example of wp-config.php for debugging:
     // Enable WP_DEBUG mode
    define( 'WP_DEBUG', true );
    
    // Enable Debug logging to the /wp-content/debug.log file
    define( 'WP_DEBUG_LOG', true );
    
    // Loads unminified core files
    define( 'SCRIPT_DEBUG', true );
    
  • Commit the package.lock file. Read more about why here.
  • Your editor should recognize the .eslintrc and .editorconfig files within the Repo's root directory. Please only submit PRs following those coding style rulesets.
  • Read CONTRIBUTING.md - it contains more about contributing to GiveWP.