Stars: 304
Forks: 183
Pull Requests: 3336
Issues: 3534
Watchers: 28
Last Updated: 2023-09-16 01:14:43
GiveWP - The #1 Donation Plugin for WordPress. Easily accept donations and fundraise using your WordPress website.
License: GNU General Public License v3.0
Languages: JavaScript, PHP, Shell, Hack, HTML, SCSS, CSS, TypeScript
GiveWP - The #1 WordPress Fundraising Plugin 💚
This plugin is the highest rated, most downloaded, and best supported donation plugin for WordPress. Built from the ground up for all your fundraising needs, GiveWP provides you with a powerful donation platform optimized for online giving that's both easy-to-use for beginners yet flexible for developers to craft their own unique giving experiences.
👉 Not a developer? Running WordPress? Download GiveWP on WordPress.org.
Welcome to the GiveWP GitHub repository. This is the core repository and heart of an ecosystem of active development. Here you can browse the source, look at open issues, and contribute to the project.
Many of our add-ons are in public repositories, however, the majority are private. If you have a legitimate need for access, please reach out to us and we'll be happy to grant you access.
This repository is not suitable for WordPress admin or donor support. Please don't use GitHub issues for non-development related support requests. Don't get us wrong, we're more than happy to help you! However, to get the support you need please use the following channels:
If you're looking to contribute or actively develop on GiveWP, welcome! We're glad you're here. Please ⭐️ this repository and fork it to begin local development.
Most of us are using Local by Flywheel to develop on WordPress, which makes set up quick and easy. If you prefer Docker, VVV, or another flavor of local development that's cool too!
To get started developing on the GiveWP platform you will need to perform the following steps:
give.test
as the URLcd
into your local plugins directory: /path/to/wp-content/plugins/
give
directorycomposer install
to set up dependenciesnpm install
to get the necessary npm packagesnpm run watch
to start the watch process which will build the sass and script files and live reload using BrowsersyncThat's it. You're now ready to start development.
Available commands
Command | Description |
---|---|
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. |
npm run test |
Run jest tests. Make sure that your docker container is running before running this command. Read more |
Development Notes
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 );
package.lock
file. Read more about why here..eslintrc
and .editorconfig
files within the Repo's root directory. Please only submit PRs following those coding style rulesets.