evanschleret/notificationcompass

Context-aware notification preferences for Laravel applications.

v1.0.1 2026-08-06 11:16 UTC

Requires

• php: ^8.2
• illuminate/database: ^11.0|^12.0
• illuminate/notifications: ^11.0|^12.0
• illuminate/support: ^11.0|^12.0

Requires (Dev)

• orchestra/testbench: ^9.0|^10.0
• phpunit/phpunit: ^10.0|^11.0|^12.0

MIT

• Evan Schleret

Published on Packagist.org on 2026-08-06 11:19 UTC

README

NotificationCompass is a Laravel package for managing notification preferences above Laravel's native notification system.

It helps applications decide whether a notification should be sent to a user, through a channel, and in an optional business context. It supports global and context-specific preferences, defaults, opt-in notifications, and mandatory notifications while remaining independent from application-specific domain models.

Status

NotificationCompass follows the v1.x API contract. Breaking changes are reserved for a future major release.

Installation

Install the latest v1.x release with Composer:

composer require evanschleret/notificationcompass

To test unreleased changes, configure the repository and require the dev-main branch explicitly:

composer config repositories.notificationcompass vcs https://github.com/EvanSchleret/NotificationCompass
composer require evanschleret/notificationcompass:dev-main

Documentation

Read the NotificationCompass documentation for installation, concepts, configuration, API reference, and integration guides.

Contributing

Contributions are welcome. Please read CONTRIBUTING.md before opening an issue or pull request.

Security

Please report vulnerabilities privately. See SECURITY.md for the reporting process.

License

NotificationCompass is released under the MIT License.