gammamatrix/playground-matrix-resource

Playground: Provides an API and a Blade UI for interacting with Playground Matrix, a Project Management System for Laravel applications.

dev-develop / 74.x-dev 2025-09-01 18:15 UTC

This package is auto-updated.

Last update: 2025-09-01 18:28:40 UTC


README

Playground CI Workflow Test Coverage

Playground: Matrix Resource

This package provides an API and a Blade UI for interacting with the Playground: Matrix, a project management and task system.

If you need a project management system without a UI, then have a look at Playground: Matrix API.

Documentation

Read more on using Playground: Matrix Resource at Read the Docs: Playground Documentation

Postman

OpenAPI

This application provides OpenAPI documentation: openapi.json.

  • 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: Matrix Resource API.

See package.json requirements.

Install npm.

npm install

Build the documentation to generate the openapi.json configuration.

npm run docs

Documentation

Installation

You can install the package via composer:

composer require gammamatrix/playground-matrix-resource

artisan about

Playground provides information in the artisan about command.

screenshot of artisan about command with Playground: Matrix Resource.

Configuration

You can publish the config file with:

php artisan vendor:publish --provider="Playground\Matrix\Resource\ServiceProvider" --tag="playground-config"

All routes are enabled by default. They may be disabled via enviroment variable or the configuration.

See the contents of the published config file: config/playground-matrix-resource.php

You can publish the routes file with:

php artisan vendor:publish --provider="Playground\Matrix\Resource\ServiceProvider" --tag="playground-routes"
  • The routes while be published in a folder at routes/playground-matrix-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-matrix a Laravel package.

Cloc

composer cloc
➜  playground-matrix-resource git:(feature/GH-20) ✗ composer cloc
    1330 text files.
    1250 unique files.
     330 files ignored.

github.com/AlDanial/cloc v 2.06  T=0.40 s (3145.9 files/s, 258045.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                           496              0              0          39807
PHP                            470           5055           5915          23324
YAML                           163              5              0          16613
Blade                          112            721             15          10562
XML                              5              0              7            313
Markdown                         3             56              3            123
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                          1250           5840           5940          90754
-------------------------------------------------------------------------------

PHPStan

Tests at level 10 on:

  • config/
  • lang/
  • resources/views/
  • routes/
  • src/
  • tests/Feature/
  • tests/Unit/
composer analyse

Coding Standards

composer format

Testing

Run unit tests:

composer test

Run unit and feature tests:

composer test-dev

Changelog

Please see CHANGELOG for more information on what has changed recently.

License

The MIT License (MIT). Please see License File for more information.