README

sshilko/example-sdk-php

This repository is example PHP project structure with premade CI/CD for building hiqh quality PHP code projects.

Features

• Setup is Linux/OSX compatible for x86/ARMv8/AppleSilicon CPUs
• Docker and Docker-Compose configurations
• Gitlab CI/CD pipelines for building project
  • Docker Buildkit enabled
  • Docker >= 26
  • Alpine >=3.19
  • PHPUnit 9
  • PHP >=8.1
• IDE defaults for consistent styles
  • Works out of the box with PHPStorm including PHPUnit tests
• Production quality PHP ini defaults
• Strict default configs for static analysis for 100% coverage: Psalm, PHPStan, Phan
• Domain-Driven Design project structure
• Pre-commit basic checks
• PHPUnit configuration with code coverage calculation (and CI/CD integration)
  • Reporting all output formats Clover/Crap4j/Covertura/XML/HTML/Text/JUnit
  • Badges auto generation
• PSR-4 namespaced source code and PHPUnit coverage
• CI/CD
  • Build docker container and store in Gitlab Container registry
  • Build composer package and store in Gitlab Package repository
• PHP Static Analysis (and CI/CD integration)
  • PHP syntax tests
  • PHP Code Beautifier & PHP CodeSniffer
  • Psalm
  • PHPStan
  • PHPMD
  • Phan
  • Pdepend

Installation

See CONTRIBUTING.md for details

composer require sshilko/example-sdk-php