wmde/fundraising-payments

Name: fundraising-payments

Owner: Wikimedia Deutschland e.V.

Description: Bounded Context for the Wikimedia Deutschland fundraising payment subdomain

Created: 2018-01-23 23:20:50.0

Updated: 2018-05-09 14:58:42.0

Pushed: 2018-05-09 14:58:44.0

Homepage: null

Size: 105

Language: PHP

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Fundraising Payments

Bounded Context for the Wikimedia Deutschland fundraising payment (sub-)domain. Used by the user facing donation application and the “Fundraising Operations Center” (which is not public software).

Installation

To use the Fundraising Payments library in your project, simply add a dependency on wmde/fundraising-payments to your project's composer.json file. Here is a minimal example of a composer.json file that just defines a dependency on Fundraising Payments 1.x:

"require": {
    "wmde/fundraising-payments": "~1.0"
}

Development

For development you need to have Docker and Docker-compose installed. Local PHP and Composer are not needed.

sudo apt-get install docker docker-compose

Running Composer

To pull in the project dependencies via Composer, run:

make composer install

You can run other Composer commands via make run, but at present this does not support argument flags. If you need to execute such a command, you can do so in this format:

docker run --rm --interactive --tty --volume $PWD:/app -w /app\
 --volume ~/.composer:/composer --user $(id -u):$(id -g) composer composer install --no-scripts

Where composer install --no-scripts is the command being run.

Running the CI checks

To run all CI checks, which includes PHPUnit tests, PHPCS style checks and coverage tag validation, run:

make

Running the tests

To run just the PHPUnit tests run

make test

To run only a subset of PHPUnit tests or otherwise pass flags to PHPUnit, run

docker-compose run --rm app ./vendor/bin/phpunit --filter SomeClassNameOrFilter