Download the PHP package fluid-project/hearth without Composer
On this page you can find all versions of the php package fluid-project/hearth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download fluid-project/hearth
More information about fluid-project/hearth
Files in fluid-project/hearth
Package hearth
Short Description Simple starter kit for the Laravel framework.
License MIT
Homepage https://github.com/fluid-project/hearth
Informations about the package hearth
Hearth
A simple starter kit for the Laravel framework.
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
Hearth requires PHP >= 8.1 and Laravel >= 10.
You may use Composer to install Hearth into your new Laravel project:
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:
After installing Hearth, you will need to install and build your NPM dependencies, run your database migrations and link public storage:
Emails
In order to test emails (for example, using Mailhog with Laravel Sail),
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 [email protected]
(assuming your local
application is accessible at http://hearth.test
).
Usage
TODO.
Formatting
To format your code using Laravel Pint, you can run:
This should be done prior to each commit, or at least prior to opening a pull request.
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
. Then run:
You can get code coverage results if XDebug is installed by running:
To test the code located in the stubs
directory you'll need to install Hearth into a Laravel instance and
run the tests from there.
Analysis/Linting
The code should pass level 5 testing.
To analyze the code located in the Larastan will need to be manually installed.
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
- All Contributors
License
The BSD 3-Clause License. Please see License File for more information.
Third Party Software in Hearth
Hearth is based on other publicly available software, categorized by license:
MIT License
All versions of hearth with dependencies
chinleung/laravel-locales Version ^2.0
chinleung/laravel-multilingual-routes Version ^4.0
codezero/laravel-unique-translation Version ^4.0
commerceguys/addressing Version ^2.0
commerceguys/intl Version ^2.0
laravel/fortify Version ^1.10
laravel/framework Version ^10.0
livewire/livewire Version ^2.0|^3.0
shiftonelabs/laravel-cascade-deletes Version ^2.0
spatie/laravel-flash Version ^1.9
spatie/laravel-google-fonts Version ^1.1
spatie/laravel-package-tools Version ^1.11
spatie/laravel-sluggable Version ^3.3
spatie/laravel-translatable Version ^6.0