PHP Package Boilerplate

Use this project as a starting point for PHP packages.

Requirements

• php: >7.1
• composer installed

Startup Steps

• Clone to your localhost git clone https://github.com/RapidAgileSoftware/package-boilerplate NEW_PACKAGE_NAME

• Remove src/Example.php and tests/unit/ExampleTest.php

• Adjust composer.json:

  • name: NEW_PACKAGE_NAME
  • autoload and autoload-dev NEW_PACKAGE_NAMESPACE
  • phpunit or codeception for testing? Set dependencies here

• Adjust README.md:

  • set package name
  • set Travis CI badge
  • add description what this project is about
  • add Requirements (PHP version, composer, ...)
  • add example usage

• Run composer install

• Switch to your new remote

rm -rf .git
git init
git add .
git commit -m "feat(All): Start"
git remote add origin <github-uri>
git push -u --force origin master

• check the repo SETTINGS > collaborators & teams: SuperAdmins have Admin rights, Developers have Write access

Scripts

Run Tests

composer test

Run Tests with code coverage

composer test:coverage

Lint

composer lint

Run linting with auto-fix

composer lint:fix