gammamatrix / playground-matrix
Playground: This package provides the models to use Playground Matrix, a project management tool.
Requires
- php: ^8.2
- gammamatrix/playground: dev-develop|dev-master|dev-feature/*|^73.0@dev|^73.0
Requires (Dev)
- gammamatrix/playground-test: dev-develop|dev-master|dev-feature/*|^73.0@dev|^73.0
Suggests
- gammamatrix/playground-matrix-api: Provides an API, without a UI, to interact with the models provided in this package.
- gammamatrix/playground-matrix-resource: Provides a resource API and optional Blade UI to interact with the models provided in this package.
This package is auto-updated.
Last update: 2024-05-21 04:22:15 UTC
README
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.
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:
- Backlogs
- Boards
- Epics
- Flows
- Matrices
- Milestones
- Notes
- Projects
- Releases
- Roadmaps
- Sources
- Sprints
- Tags
- Teams
- Tickets
- Versions
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"
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.