Skip to content

Latest commit

 

History

History
142 lines (102 loc) · 5.09 KB

README.md

File metadata and controls

142 lines (102 loc) · 5.09 KB
Raw

Playground: Matrix

Playground CI Workflow Test Coverage PHPStan Level 9

The Playground Matrix is a package for Laravel applications.

This package provides the models to use Playground Matrix, a project management tool.

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

Installation

This package is required with playground-matrix-api (API without UI) or playground-matrix-resource (API with UI)

If you do not need an API and just want the models, then the package may be installed with:

You can install the package via composer:

composer require gammamatrix/playground-matrix

artisan:about

Playground Matrix provides information in the artisan about command.

screenshot of artisan about command with Playground Matrix.

Configuration

Migrations are disabled by default. This package may sometimes be installed where another system handles the migrations.

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

You can publish the config file with:

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

Environment Variables

env() config()
PLAYGROUND_MATRIX_LOAD_MIGRATIONS playground-matrix.load.migrations
  • The loading option for migrations does not take effect if the migrations have been exported to your app. The control for loading is handled in the package ServiceProvider.

Models

This package includes factories, models and migrations for:

Migrations

All database/migrations are disabled by default.

  • NOTE: There are 16 tables that will be created, they do have indexes and unique constraints defined; however, this release does not have the foreign key constraint migrations included at this time.

You can publish the migrations file with:

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

Cloc

composer cloc
➜  playground-matrix git:(feature/GH-25) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .
     148 text files.
     118 unique files.
      32 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.29 s (405.5 files/s, 234827.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                            18              0              0          49172
PHP                             92           1285           4715          12506
YAML                             1              5              0            275
XML                              3              0              7            215
Markdown                         3             44              0            102
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           118           1337           4722          62282
-------------------------------------------------------------------------------

PHPStan

Tests at level 9 on:

  • config/
  • database/
  • src/
  • tests/Feature/
  • tests/Unit/
composer analyse

Coding Standards

composer format

Testing

composer test

Changelog

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

Credits

License

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