PHPackages                             fluid-project/hearth - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. fluid-project/hearth

Abandoned → [fluid-project/hearth-components](/?search=fluid-project%2Fhearth-components)ArchivedLibrary[Framework](/categories/framework)

fluid-project/hearth
====================

Simple starter kit for the Laravel framework.

4.1.0(2y ago)316.2k↑50%4MITPHPPHP ^8.1

Since Aug 26Pushed 1y ago6 watchersCompare

[ Source](https://github.com/fluid-project/hearth)[ Packagist](https://packagist.org/packages/fluid-project/hearth)[ Docs](https://github.com/fluid-project/hearth)[ RSS](/packages/fluid-project-hearth/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (20)Versions (21)Used By (0)

Hearth
======

[](#hearth)

**NOTE: This project is no longer maintained. Please use [fluid-project/hearth-components](https://github.com/fluid-project/hearth-components) instead.**

A simple starter kit for the Laravel framework.

[![Latest Version on Packagist](https://camo.githubusercontent.com/a294764f908106d6ebf20d5c94d9dd11dbe00c6ddb717675d5f8cb332423ab42/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f762f666c7569642d70726f6a6563742f6865617274682f)](https://packagist.org/packages/fluid-project/hearth)[![GitHub Tests Action Status](https://camo.githubusercontent.com/8661c5c20b7769b7c979dc04f18a3b7b529a3ccfc9ecc7e5bff1ca5c36afd292/68747470733a2f2f62616467656e2e6e65742f6769746875622f636865636b732f666c7569642d70726f6a6563742f6865617274682f6d61696e2f746573743f6c6162656c3d7465737473)](https://github.com/fluid-project/hearth/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/cad73180bebbe8e80d66fb443bd3dfd8884d5d761e3d136651345bb874cc5a39/68747470733a2f2f62616467656e2e6e65742f6769746875622f636865636b732f666c7569642d70726f6a6563742f6865617274682f6d61696e2f7068702d63732d66697865723f6c6162656c3d636f64652532307374796c65)](https://github.com/fluid-project/hearth/actions?query=workflow%3A%22Check+%26+fix+styling%22+branch%3Amain)[![Code coverage status](https://camo.githubusercontent.com/af4d60460e269b14f0a5c225555fc15e1444118b41f02127448fec9e9d57baf1/68747470733a2f2f62616467656e2e6e65742f636f6465636f762f632f6769746875622f666c7569642d70726f6a6563742f686561727468)](https://app.codecov.io/gh/fluid-project/hearth/)[![Localization status](https://camo.githubusercontent.com/21c79441bec830b78047127822d16e23372fc74dc99d9a2ea8b7238fe8a43db6/68747470733a2f2f6261646765732e63726f7764696e2e6e65742f6c61726176656c2d6865617274682f6c6f63616c697a65642e737667)](https://crowdin.com/project/laravel-hearth)[![Total Downloads](https://camo.githubusercontent.com/a638334443c1179d5ffd51bdb5eb1b76820d9a8a109f6228e1c232a83a979ca4/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f64742f666c7569642d70726f6a6563742f686561727468)](https://packagist.org/packages/fluid-project/hearth)

---

Hearth is a simple starter kit for the Laravel framework. It provides a few things out of the box:

- A user model with login, registration, email verification
- Optional two-factor authentication support for users.
- An organization model.
- A membership model which reflects users' roles within organizations.
- An invitation model which allows users to be invited to join organizations.
- A resource model supporting creation of and access to a library of open educational resources in a wide range of formats.
- Multilingual support, including localized routes.
- Bare bones views which can be published and customized as needed.

Installation
------------

[](#installation)

Hearth requires PHP &gt;= 8.2 and Laravel &gt;= 10.

You may use Composer to install Hearth into your new Laravel project:

```
composer require fluid-project/hearth
```

*Note: attempting to install Hearth into an existing Laravel application will result in unexpected behaviour.*

After installing the Hearth package, you can use the `hearth:install` Artisan command to install the Hearth scaffolding within your Laravel application:

```
php artisan hearth:install
```

After installing Hearth, you will need to install and build your NPM dependencies, run your database migrations and link public storage:

```
npm install
php artisan migrate
php artisan storage:link
```

### Emails

[](#emails)

In order to test emails (for example, using Mailhog with [Laravel Sail](https://laravel.com/docs/10.x/sail#previewing-emails)), you must update your Laravel application's `.env` file's `MAIL_FROM_ADDRESS` environment variable with a properly-formatted email address. For local development, this might be `noreply@hearth.test` (assuming your local application is accessible at `http://hearth.test`).

Usage
-----

[](#usage)

TODO.

Formatting
----------

[](#formatting)

To format your code using [Laravel Pint](https://github.com/laravel/pint), you can run:

```
composer format
```

This should be done prior to each commit, or at least prior to opening a pull request.

Testing
-------

[](#testing)

Prior to testing, you will need to create a MySQL or MariaDB database for testing with credentials which match those in [`phpunit.xml.dist`](phpunit.xml.dist). Then run:

```
composer test
```

You can get code coverage results if XDebug is installed by running:

```
composer test-coverage
```

To test the code located in the [`stubs`](./stubs) directory you'll need to install Hearth into a Laravel instance and run the tests from there.

Analysis/Linting
----------------

[](#analysislinting)

The code should pass level 5 testing.

```
composer analyze
```

To analyze the code located in the [`stubs`](./stubs) directory you'll need to install Hearth into a Laravel instance and run the analysis from there. The phpstan configuration is provided as part of the install, but [Larastan](https://github.com/nunomaduro/larastan) will need to be manually installed.

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [OCAD University](https://github.com/fluid-project)
- [All Contributors](../../contributors)

License
-------

[](#license)

The BSD 3-Clause License. Please see [License File](LICENSE.md) for more information.

Third Party Software in Hearth
------------------------------

[](#third-party-software-in-hearth)

Hearth is based on other publicly available software, categorized by license:

### MIT License

[](#mit-license)

- [Laravel Breeze](https://github.com/laravel/breeze)
- [Laravel Form Components](https://github.com/rawilk/laravel-form-components)
- [Laravel Jetstream](https://github.com/laravel/jetstream)
- [Laravel Package Skeleton](https://github.com/spatie/package-skeleton-laravel)

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance30

Infrequent updates — may be unmaintained

Popularity31

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 88.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~77 days

Recently: every ~140 days

Total

11

Last Release

949d ago

Major Versions

1.3.1 → 2.0.02022-03-24

2.0.2 → 3.0.02022-08-30

3.0.0 → 4.0.02023-10-06

PHP version history (3 changes)v1.0.0PHP ^8.0

2.0.0PHP ^8.0|^8.1

4.0.0PHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/43a3ec56fb89f487d5de34ed0fbca0b122c7e6d3a6e416d6458a1266bcb00f95?d=identicon)[greatislander](/maintainers/greatislander)

---

Top Contributors

[![greatislander](https://avatars.githubusercontent.com/u/605361?v=4)](https://github.com/greatislander "greatislander (283 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (11 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (10 commits)")[![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4)](https://github.com/renovate[bot] "renovate[bot] (7 commits)")[![chosww](https://avatars.githubusercontent.com/u/22668696?v=4)](https://github.com/chosww "chosww (6 commits)")[![jobara](https://avatars.githubusercontent.com/u/556024?v=4)](https://github.com/jobara "jobara (2 commits)")

---

Tags

fluid-projecthearthlaravellaravelhearthfluid-project

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/fluid-project-hearth/health.svg)

```
[![Health](https://phpackages.com/badges/fluid-project-hearth/health.svg)](https://phpackages.com/packages/fluid-project-hearth)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
