/fundraising-payments

Bounded Context for the Wikimedia Deutschland fundraising payment subdomain

Primary LanguagePHPOtherNOASSERTION

Fundraising Payments

Build Status Scrutinizer Code Quality Code Coverage

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, 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

This project has a Makefile that runs all tasks in Docker containers via docker-compose. You need to have Docker and the docker-compose CLI installed on your machine.

Installing dependencies

To pull in the project dependencies via Composer, run:

make install-php

Running the CI checks

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

make ci

Running the tests

To run the PHPUnit tests run

make test

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

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

Architecture

This Bounded context follows the architecture rules outlined in Clean Architecture + Bounded Contexts.

Architecture diagram