README

Robust components for the Laravel Framework.

Installation

Prerequisites

Hearth Components requires Laravel >= 12.x and PHP >= 8.4.

You can install the package via composer:

composer require fluid-project/hearth-components

Optionally, you can publish the views using

php artisan vendor:publish --tag="hearth-components-views"

Usage

For component usage, see the wiki.

Testing

To run automated tests:

composer test

To test integration in a Laravel application:

1. Create a new Laravel project for testing.

   laravel new hearth-test
   

2. Answer the interactive questions in the installer as follows.

   1. Which starter kit would you like to use? None
   2. Which testing framework do you prefer? Pest
   3. Do you want to install Laravel Boost to improve AI assisted coding? No
   4. Which database will your application use? SQLite
   5. Would you like to run npm install --ignore-scripts and npm run build? Yes

3. Add Hearth to your new Laravel project.

   cd hearth-test
   composer require fluid-project/hearth-components
   

4. Create a new view route and add components to the view as per the instructions.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• OCAD University

License

The BSD 3-Clause License. Please see License File for more information.