diff --git a/README.md b/README.md new file mode 100644 index 0000000..6cde1d0 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +

+Laravel Package Skeleton Logo +
Laravel Package Skeleton +

+

+Build Status +Total Downloads +Latest Stable Version +License +

+ +Creating Laravel packages made it easy! You can start building your own modular, organized package effortlessly. + +> [!NOTE] +> This package requires PHP 8.2+ and Laravel 11+ + +## Installation + +You can install the package globally via composer: + +``` +composer global require algoyounes/laravel-package-skeleton +``` + +## Usage + +Once installed, you can use the following commands to streamline your package development process: + +**โšก๏ธ Create your package using composer :** +``` +composer create-project algoyounes/laravel-package-skeleton --prefer-source YourPackageName +``` + +**๐Ÿš€ Run the entire test suite :** +``` +composer test +``` + +Running `composer test` will execute the following tasks : +- ๐Ÿ”„ Refactoring Tests: `composer rector` +- ๐Ÿงน Linting Tests: `composer test:lint` +- ๐Ÿ” Static Analysis Tests: `composer test:types` +- ๐Ÿ› ๏ธ Unit Tests: `composer test:unit` + +**๐Ÿ”ง Install Git Hooks:** +``` +composer hook:install +``` +Running `composer hook` will execute the following tasks : +- ๐Ÿ”„ Pre-commit Hook: `composer hook:pre-commit` +- ๐Ÿงน Pre-push Hook: `composer hook:pre-push` + +**๐Ÿ› ๏ธ Fix code issues:** +``` +composer fix +``` +Running `composer fix` will execute the following tasks: +- โœจ Laravel linting Fixes: `composer fix:lint` +- ๐Ÿ”„ Refactoring Fixes: `composer fix:refactor`