README

Description

User Groups manages Enso user grouping and selection flows.

The package stores user group records, exposes create/edit/table/export endpoints, returns select options for other backend packages, and provides the enum and model used by the users package to classify accounts.

Installation

Install the package:

composer require laravel-enso/user-groups

Run the migrations:

php artisan migrate

Features

• CRUD API for user groups.
• Table bootstrap, data, and export endpoints.
• Select options endpoint for dependent forms.
• Shared enum and model consumed by laravel-enso/users.

Usage

Routes are registered under:

• prefix: api/administration/userGroups
• name prefix: administration.userGroups.
• middleware: api, auth, core

Endpoints:

• GET create
• POST /
• GET {userGroup}/edit
• PATCH {userGroup}
• DELETE {userGroup}
• GET initTable
• GET tableData
• GET exportExcel
• GET options

Main classes:

• LaravelEnso\UserGroups\Models\UserGroup
• LaravelEnso\UserGroups\Enums\UserGroups

API

This package exposes its backend integration through the routes, controllers, services, jobs, and configuration points referenced in the usage examples above.

Consumers should rely on the published config keys, documented route groups, and explicit service classes shown in the examples. Internal helper classes, listeners, casts, and background jobs are implementation details unless the README calls them out as extension points.

Depends On

Required Enso packages:

• laravel-enso/core ↗
• laravel-enso/enums ↗
• laravel-enso/forms ↗
• laravel-enso/helpers ↗
• laravel-enso/migrator ↗
• laravel-enso/rememberable ↗
• laravel-enso/roles ↗
• laravel-enso/select ↗
• laravel-enso/tables ↗
• laravel-enso/users ↗

Companion frontend package:

• @enso-ui/user-groups ↗

Contributions

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

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