Giter VIP home page Giter VIP logo

jeromebeckett / givewp Goto Github PK

View Code? Open in Web Editor NEW

This project forked from impress-org/givewp

0.0 0.0 0.0 113.67 MB

GiveWP - The #1 Donation Plugin for WordPress. Easily accept donations and fundraise using your WordPress website.

Home Page: https://givewp.com/

License: GNU General Public License v3.0

Shell 0.03% JavaScript 10.47% PHP 71.00% TypeScript 7.38% CSS 0.13% Hack 0.03% HTML 0.02% SCSS 10.95%

givewp's Introduction

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.

WordPress version WordPress Rating WordPress Downloads License Wordpress Tests

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.

๐Ÿ™‹ Support

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:

๐ŸŒฑ Getting Started

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!

โœ… Prerequisites

  • Node.js as JavaScript engine
  • NPM npm command globally available in CLI
  • Composer composer command globally available in CLI

๐Ÿ’ป Local Development

To get started developing on the GiveWP 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. Fork this repository from GitHub and then clone that into your plugins directory in a new give directory
  4. Run composer install to set up dependencies
  5. Run npm install to get the necessary npm packages
  6. Activate the plugin in WordPress
  7. Run npm run watch to start the watch process which will build the sass and script files and live reload using Browsersync

That'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

  • 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.

givewp's People

Contributors

ajitbohra avatar alaca avatar angelablake avatar benunc avatar bradp avatar devinwalker avatar emgk avatar glaubersilva avatar henryholtgeerts avatar jasontheadams avatar jaydeeprami avatar jonwaldstein avatar joshuahungdinh avatar kakshakmultidots avatar kevinlangleyjr avatar kevinwhoffman avatar kjohnson avatar knowler avatar lmntl avatar mathetos avatar mehul0810 avatar mikejhale avatar nishitlangaliya avatar pauloiankoski avatar pryley avatar raftaar1191 avatar ramiy avatar ravinderk avatar sidsector9 avatar tw2113 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.