gammamatrix / playground-cms-resource
Playground: Provides an API and a Blade UI for interacting with Playground CMS, a Content Management System for Laravel applications.
Installs: 64
Dependents: 2
Suggesters: 1
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
pkg:composer/gammamatrix/playground-cms-resource
Requires
Requires (Dev)
This package is auto-updated.
Last update: 2025-10-04 05:01:12 UTC
README
Playground: CMS Resource
This package provides an API and a Blade UI for interacting with the Playground: CMS, a model package for Laravel.
If you need a JSON API without a UI, then have a look at Playground: CMS API.
Documentation
Read more on using Playground: CMS Resource at Read the Docs: Playground Documentation
Postman
A postman collection is provided in the repository: postman-playground-cms-resource.json.
- This same collection is viewable on the Postman: GammaMatrix Playground Workspace.
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: CMS 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-cms-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\Cms\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-cms-resource.php
You can publish the routes file with:
php artisan vendor:publish --provider="Playground\Cms\Resource\ServiceProvider" --tag="playground-routes"
- The routes while be published in a folder at
routes/playground-cms-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-cms a Laravel package.
Cloc
composer cloc
➜ playground-cms-resource git:(develop) ✗ composer cloc
241 text files.
232 unique files.
52 files ignored.
github.com/AlDanial/cloc v 2.06 T=0.08 s (2875.3 files/s, 473540.1 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
JSON 84 0 0 21759
YAML 30 5 0 6359
PHP 83 999 1360 4071
Blade 18 91 0 2439
XML 13 0 7 908
Markdown 3 58 1 137
INI 1 3 0 12
-------------------------------------------------------------------------------
SUM: 232 1156 1368 35685
-------------------------------------------------------------------------------
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.