@@ -500,6 +500,86 @@ php artisan dusk
500500* Date range filters
501501* Switch to Vite for the demo app
502502
503+ ## Local Development
504+
505+ If you want to work on this package locally and test changes in your application, you can use npm's ` file: ` protocol to create a symlink.
506+
507+ ### Setup
508+
509+ 1 . ** Clone the package repository** to your local machine:
510+ ``` bash
511+ git clone https://github.com/your-username/inertiajs-tables-laravel-query-builder.git /path/to/package
512+ ```
513+
514+ 2 . ** Install package dependencies** :
515+ ``` bash
516+ cd /path/to/package
517+ npm install
518+ ```
519+
520+ 3 . ** Update your application's ` package.json ` ** to point to the local package:
521+ ``` json
522+ {
523+ "devDependencies" : {
524+ "@protonemedia/inertiajs-tables-laravel-query-builder" : " file:/absolute/path/to/package"
525+ }
526+ }
527+ ```
528+
529+ 4 . ** Install dependencies in your application** :
530+ ``` bash
531+ cd /path/to/your-application
532+ npm install
533+ ```
534+ This will create a symlink from ` node_modules/@protonemedia/inertiajs-tables-laravel-query-builder ` to your local package directory.
535+
536+ 5 . ** Start the package build watcher** (in the package directory):
537+ ``` bash
538+ cd /path/to/package
539+ npm run dev
540+ ```
541+ This runs ` vite build --watch ` , which will automatically rebuild the package whenever you make changes.
542+
543+ 6 . ** Start your application's dev server** (in another terminal):
544+ ``` bash
545+ cd /path/to/your-application
546+ npm run dev
547+ ```
548+
549+ ### Making Changes
550+
551+ Now any changes you make to the package source files will:
552+ 1 . Be automatically rebuilt by the package's watch process
553+ 2 . Be immediately available to your application via the symlink
554+ 3 . Trigger your application's hot module reload (if using Vite/HMR)
555+
556+ ### Installing the Composer Package
557+
558+ If you also forked the package and want to use your fork in your Laravel application:
559+
560+ ``` bash
561+ composer require protonemedia/inertiajs-tables-laravel-query-builder:dev-main
562+ ```
563+
564+ Make sure to update your ` composer.json ` to point to your fork:
565+
566+ ``` json
567+ {
568+ "repositories" : [
569+ {
570+ "type" : " vcs" ,
571+ "url" : " https://github.com/your-username/inertiajs-tables-laravel-query-builder"
572+ }
573+ ]
574+ }
575+ ```
576+
577+ ### Troubleshooting
578+
579+ - ** Changes not appearing?** Make sure the package's ` npm run dev ` is running and watch for build errors
580+ - ** Old build artifacts?** Try deleting the ` dist ` folder in the package and rebuilding
581+ - ** Symlink not working?** Run ` npm install ` again in your application to recreate the symlink
582+
503583## Changelog
504584
505585Please see [ CHANGELOG] ( CHANGELOG.md ) for more information what has changed recently.
0 commit comments