README

The Playground Matrix is a package for Laravel applications.

Playground: Provides the models to use Playground Matrix, a Project Management System.

Read more on using Playground: Matrix at Read the Docs

Installation

NOTE: This package is required by:

• Playground: Matrix API: API without UI
• Playground: Matrix Resource: API with UI

Install this package, with composer, to get access to the Matrix Models:

composer require gammamatrix/playground-matrix

artisan:about

Playground Matrix provides information in the artisan about command.

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

• 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:

• Backlog
• Board
• Epic
• Flow
• Matrix
• Milestone
• Note
• Project
• Release
• Roadmap
• Source
• Sprint
• Tag
• Team
• Ticket
• Version

Migrations

All migrations are disabled by default.

See the contents of the published config file: database/migrations

• 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:(develop) ✗ composer cloc
     200 text files.
     195 unique files.
      25 files ignored.

github.com/AlDanial/cloc v 2.06  T=0.13 s (1530.8 files/s, 545559.2 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                            89              0              0          50576
PHP                             91           1461           4161          12348
XML                             10              0              7            470
YAML                             1              5              0            275
Markdown                         3             46              0            132
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           195           1515           4168          63813
-------------------------------------------------------------------------------

PHPStan

Tests at level 10 on:

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

composer analyse

Coding Standards

composer format

Testing

Unit tests

composer test

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.

Credits

• Jeremy Postlethwaite

License

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