Contributing
1 Clone the repository
In the root of a Laravel app with Livewire 4 and Tailwind CSS 4, create a packages folder and clone TallCraftUI into it:
mkdir packagesgit clone https://github.com/developermithu/tallcraftui.git packages/tallcraftui
Fork the repository first if you plan to open a pull request, and clone your fork instead.
2 Link the local package
Add a path repository to the app's composer.json and allow development versions:
"minimum-stability": "dev","prefer-stable": true,"repositories": { "developermithu/tallcraftui": { "type": "path", "url": "packages/tallcraftui", "options": { "symlink": true } }},
Then require the package. Composer symlinks vendor/developermithu/tallcraftui to your clone:
composer require developermithu/tallcraftui:@devphp artisan install:tallcraftui
3 Start the dev server
The published tallcraftui.css tells Tailwind to scan vendor/developermithu/tallcraftui/src, which now points at your clone, so new classes in components are picked up automatically.
npm run dev # or: bun dev
Components live in src/View/Components. After changing a component class, run php artisan view:clear if the change doesn't show up.
4 Open a pull request
- Format PHP with Laravel Pint:
vendor/bin/pint. - Keep each pull request focused on one change and describe how you tested it.
- For new components or larger changes, open an issue first to discuss the API.
Improving these docs? The documentation site is open source too: developermithu/tallcraftui.com. Every page has an "Edit this page on GitHub" link at the bottom.