notifications

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 8 Open GitHub ↗

Laravel Enso Notifications package, built to be used with pusher, is meant for keeping your users in the loop with real time notifications

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Notifications

[![License](https://poser.pugx.org/laravel-enso/notifications/license)](https://raw.githubusercontent.com/laravel-enso/notifications/master/LICENSE)
[![Stable](https://poser.pugx.org/laravel-enso/notifications/version)](https://packagist.org/packages/laravel-enso/notifications)
[![Downloads](https://poser.pugx.org/laravel-enso/notifications/downloads)](https://packagist.org/packages/laravel-enso/notifications)
[![PHP](https://img.shields.io/badge/php-8.2%2B-777bb4.svg)](https://raw.githubusercontent.com/laravel-enso/notifications/master/composer.json)
[![Issues](https://img.shields.io/github/issues/laravel-enso/notifications.svg)](https://github.com/laravel-enso/notifications/issues)
[![Merge Requests](https://img.shields.io/github/issues-pr/laravel-enso/notifications.svg)](https://github.com/laravel-enso/notifications/pulls)

## Description

Notifications provides Enso API endpoints and broadcast channels for user notifications.

The package exposes listing, counting, read, read-all, delete, and delete-all endpoints on top of Laravel's database notifications, and registers a per-user broadcast channel based on the configured auth model.

It is intended to back the Enso notification dropdown and related realtime UI flows.

## Installation

Install the package:

```bash
composer require laravel-enso/notifications
```

Run the package migrations:

```bash
php artisan migrate
```

## Features

- Notification list and unread-count endpoints.
- Mark-one and mark-all-as-read endpoints.
- Delete-one and delete-all endpoints.
- Broadcast channel registration for user-specific notification streams.

## Usage

Main route group:

- `core.notifications.*`

The broadcast channel is derived from the configured auth model namespace and ends with `.{id}`.

## API

### HTTP routes

- `GET api/core/notifications`
- `DELETE api/core/notifications/destroyAll`
- `DELETE api/core/notifications/{notification}`
- `GET api/core/notifications/count`
- `PATCH api/core/notifications/read/{notification}`
- `POST api/core/notifications/readAll`

### Broadcast

- per-user notification channel for the configured auth provider model

## Depends On

Required packages:

- [`laravel-enso/core`](https://docs.laravel-enso.com/backend/core.html) [↗](https://github.com/laravel-enso/core)
- [`laravel-enso/migrator`](https://docs.laravel-enso.com/backend/migrator.html) [↗](https://github.com/laravel-enso/migrator)
- `pusher/pusher-php-server`

Companion frontend package:

- [`@enso-ui/notifications`](https://docs.laravel-enso.com/frontend/notifications.html) [↗](https://github.com/enso-ui/notifications)

## Contributions

are welcome. Pull requests are great, but issues are good too.

Thank you to all the people who already contributed to Enso!

notifications

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README