tnapf/package

A package that does something

v1.1.0 2023-07-10 01:48 UTC

Requires

• php: >=8.1

Requires (Dev)

• ergebnis/composer-normalize: ^2.31
• fakerphp/faker: ^1.21
• friendsofphp/php-cs-fixer: ^3.16
• jetbrains/phpstorm-attributes: ^1.0
• phpunit/phpunit: ^10.1
• roave/security-advisories: dev-latest
• xheaven/composer-git-hooks: ^3.0

MIT

• Robert Snedeker
• Mark Magyar

README

A template repository for making composer packages

Requirements

• PHP 8.1+

What's Included

• Composer Normalize

• Faker

• PHP-CS-Fixer

• JetBrains Attributes

• PHPUnit

• Roave Security Advisories

• Symfony VarDumper

• Composer Git Hooks

• GitHub Actions

• Composer Scripts

  • composer test - Run PHPUnit tests
  • composer test:coverage - Run PHPUnit tests with coverage
  • composer fix:dry - Run PHP-CS-Fixer in Dry-Run mode
  • composer fix - Run PHP-CS-Fixer and fix errors

Installation

composer create-project tnapf/package <package>

Setup GitHub Repository

1. Run git init to initialize a new git repository
2. Run git add . to add all files to the repository
3. Run git commit -m "initial commit" to commit the files
4. Run git branch -M main to rename the current branch to main
5. Create a new repository on GitHub
6. Run git remote add origin https://github.com/tnapf/<package>.git to add the new repository as remote
7. Run git push -u origin main to push the files to the new repository