README

The playground-matrix-api Laravel package.

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

If you need a UI, then use Playground Matrix Resource, which provides a Blade UI.

Documentation

Read more on using Playground Matrix API at Read the Docs: Playground Documentation.

Postman

A postman collection is provided in the repository: postman-playground-matrix-api.json.

• This same collection is viewable on the Postman: GammaMatrix Playground workspace.

Swagger

This application provides Swagger documentation: swagger.json.

• The endpoint models support locks, trash with force delete, restoring, revisions and more.
• Index endpoints support advanced query filtering.

Swagger API Documentation is built with npm.

• npm is only needed to generate documentation and is not needed to operate the MATRIX API.

See package.json requirements.

Install npm.

npm install

Build the documentation to generate the swagger.json configuration.

npm run docs

Documentation

• Preview swagger.json on the Swagger Editor UI.
• Preview swagger.json on the Redocly Editor UI.

Installation

You can install the package via composer:

composer require gammamatrix/playground-matrix-api

artisan about

Playground provides information in the artisan about command.

Configuration

You can publish the config file with:

php artisan vendor:publish --provider="Playground\Matrix\Api\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-api.php

You can publish the routes file with:

php artisan vendor:publish --provider="Playground\Matrix\Api\ServiceProvider" --tag="playground-routes"

• The routes while be published in a folder at routes/playground-matrix-api

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-api git:(feature/GH-3) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .
     657 text files.
     637 unique files.
      21 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.83 s (769.0 files/s, 124350.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             6              0              0          56264
PHP                            462           3480           5704          20678
YAML                           162              5              0          16472
XML                              3              0              7            215
Markdown                         3             52              1            118
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           637           3540           5712          93759
-------------------------------------------------------------------------------

PHPStan

Tests at level 9 on:

• config/
• database/
• routes/
• src/
• tests/Feature/
• tests/Unit/

composer analyse

Coding Standards

composer format

Tests

composer test

Changelog

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