gammamatrix / playground-admin-resource
Playground: Provides an API and a Blade UI for interacting with Playground Admin, a User and Settings management System for Laravel applications.
Maintainers
Package info
github.com/gammamatrix/playground-admin-resource
pkg:composer/gammamatrix/playground-admin-resource
Requires
Requires (Dev)
This package is auto-updated.
Last update: 2026-06-20 21:25:47 UTC
README
Playground: Admin Resource
This package provides an API and a Blade UI for interacting with the Playground: Admin, a model package for Laravel.
If you need a JSON API without a UI, then have a look at Playground: Admin API.
Documentation
Read more on using Playground: Admin Resource at Read the Docs: Playground Documentation
Postman
A postman collection is provided in the repository: postman-playground-admin-resource.json.
- This same collection is viewable on the .
OpenAPI
This application provides OpenAPI documentation: openapi.yaml.
- The endpoint models support locks, trash with force delete, restoring, revisions and more.
- Index endpoints support advanced query filtering.
OpenAPI API Documentation is built with npm using Redocly.
- npm is only needed to generate documentation and is not needed to operate the Playground: Admin Resource API.
See package.json requirements.
Install npm.
npm install
Build the documentation to generate the openapi.yaml configuration.
npm run docs
Documentation
Installation
You can install the package via composer:
composer require gammamatrix/playground-admin-resource
artisan about
Playground provides information in the artisan about command.
Configuration
You can publish the config file with:
php artisan vendor:publish --provider="Playground\Admin\Resource\ServiceProvider" --tag="playground-config"
All routes are enabled by default. They may be disabled via environment variable or the configuration.
See the contents of the published config file: config/playground-admin-resource.php
You can publish the routes file with:
php artisan vendor:publish --provider="Playground\Admin\Resource\ServiceProvider" --tag="playground-routes"
- The routes while be published in a folder at
routes/playground-admin-resource
Environment Variables
If you are unable or do not want to publish configuration files for this package, you may override the options via system environment variables.
Information on environment variables is available on the wiki for this package
Migrations
This package requires the migrations in playground-admin a Laravel package.
Cloc
composer cloc
➜ playground-admin-resource git:(develop) ✗ composer cloc
119 text files.
106 unique files.
62 files ignored.
github.com/AlDanial/cloc v 2.08 T=0.07 s (1540.2 files/s, 294536.5 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
JSON 4 0 0 10671
PHP 57 824 1064 3124
YAML 15 5 6 1749
Blade 14 75 19 1574
XML 13 0 7 949
Markdown 2 54 1 133
INI 1 3 0 12
-------------------------------------------------------------------------------
SUM: 106 961 1097 18212
-------------------------------------------------------------------------------
PHPStan
Tests at level 10 on:
config/lang/resources/views/routes/src/tests/Feature/tests/Unit/
composer analyse
Coding Standards
Format source code:
composer format
Format blades in resources/views:
composer format-blade
- NOTE: requires installing dev packages from package.json.
npm install
Testing
Run unit tests:
composer test
Run unit and feature tests:
composer test-dev
Run unit and feature tests in parallel:
composer test-parallel
Changelog
Please see CHANGELOG for more information on what has changed recently.
License
The MIT License (MIT). Please see License File for more information.