Componette

Componette

orisai

orisai / library-template

Template for PHP libraries

download-cloud-line composer require todo-vendor/package

Orisai
PHP Library Template

Simple template for jump-starting standardized Orisai library development.

💸 If you like Orisai, please make a donation. Thank you!

Documentation - How to start with library template

  • Replace all TODOs in files
    • TODO - Organization >>> e.g. Orisai
    • TODO - Package >>> e.g. Object mapper
    • TODO - Description >>> e.g. This is object mapper description
    • todo-vendor/package >>> e.g. orisai/object-mapper
    • TODOname\space >>> e.g. Orisai\ObjectMapper
    • TODOname\\space >>> e.g. Orisai\\ObjectMapper
  • Fill keywords and authors in composer.json
  • Template contains some pre-configured tools
    • Makefile - type make in console
    • PHPUnit - make tests
    • Infection - make mutations
    • orisai/coding-standard - make cs and make csf
    • PHPStan - make phpstan
    • GitHub Actions - with PHPUnit, Infection, Coveralls.io, PHPStan, coding standard
  • Once you are ready for release
    • Add little code example to bottom of this file :)
    • Create a GitHub repo
    • Go to Coveralls, login with your GitHub account and ensure repository is enabled
    • Go to Stryker Dashboard, login with your GitHub account, enable repository and add the API key and save it in your repo GitHub repo secrets for action with name STRYKER_DASHBOARD_API_KEY
    • Publish repo on Packagist
  • remove everything above this statement

TODO - Organization
TODO - Package

TODO - Description

📄 Check out our documentation.

No release at this moment. Try to create first one.

bar-chart-fill

Statistics

download-cloud-fill
N/A
star-fill
3
bug-fill
0
flashlight-fill
67d
price-tag-2-line

Badges

guide-fill

Dependencies

php (>=7.4.0 <8.2.0)
guide-fill

Keywords

Componette Componette felix@nette.org