1. Create the file structure
We are going to create 4 directories and 2 files. In this example my "company" is going to be called "testcompany" and my package will be "test-package"
- Create a directory called "packages" in your Laravel application
- Create a "company" directory in the "packages" directory
- Create your actual "package" directory in the "company" directory
- Create a "src" directory in your "package" directory
- Create a ServiceProvider file in your "src" directory. You can name this after your package
- In your "package" directory create a composer.json file
2. Populate the two neccessary files
ServiceProvider: Extend the Laravel ServiceProvider and add a boot method and a register method
Composer file: You'll need a few things here so Laravel knows where to look for the package logic. You can also run
composer init in the package root and composer will guide you through the initital setup. You will still need to provide the "autoload" and "extra" objects seen here
3. Update your Laravel Application's composer.json (not your package's composer.json)
Under the "keyword" property and a new property "repositories". Then you'll want to reference it like so--
And you need to add it to your required object. Since there are no versions yet, you can set the version to
4. Run composer install in your Laravel app
The final step! Run
composer update and you will now find your package in your vendors directory!
Congratulations! You just created your very first Laravel package!
If you are ready for the next step and want to make your package open source and promote it, check out this guide!