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 / 73.x-dev 2024-03-17 07:09 UTC

This package is auto-updated.

Last update: 2024-05-22 05:10:55 UTC


README

Playground CI Workflow Test Coverage PHPStan Level 9 src and tests

The playground-matrix-resource Laravel package.

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

If you only need the JSON API, the Blade UI may be disabled.

This application provides Swagger documentation: swagger.json.

Read more on using Playground Matrix Resource at the Read the Docs for Playground.

Installation

You can install the package via composer:

composer require gammamatrix/playground-matrix-resource

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.

PHPStan

Tests at level 9 on:

  • config/
  • database/
  • resources/views/
  • 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.