README

drewmw5/breeze

Introduction

This package adds the option to install the default Laravel Breeze React scaffolding, but with all necessary types added so you can begin adding/changing the default scaffolding in Typescript! You can view a working example of the package here at https://breeze.drewmw.dev

Installation

1. Navigate to your Laravel Project's directory and require the package via composer

composer require drewmw5/breeze

2. Execute the following command

php artisan breeze:install react-ts

3. Done!

(Note: Ensure that npm i, npm run build, and php artisan route:cache have run. I run this from a docker-compose file, so I need to manually execute them. Otherwise, the package should automatically handle these commands.)

Notes

This package will install Laravel/Breeze alongside itself, so you can still use the default stack install options (e.g. php artisan breeze:install vue, php artisan breeze:install react). The package requires Laravel/Breeze but tells composer not to discover it. This allows the package to share the necessary files to install all stack options without the breeze:install command being overwritten by Laravel/Breeze.

If you've found this repo helpful, consider leaving a star! If you'd like to submit a PR, please feel free to do so. Thank you!