gammamatrix/playground-directory-resource

Playground: Provides an API and a Blade UI for interacting with Playground Directory, a Directory System for Laravel applications.

dev-develop / 73.x-dev 2024-08-16 05:53 UTC

This package is auto-updated.

Last update: 2025-02-17 21:27:40 UTC


README

Playground CI Workflow Test Coverage PHPStan Level 9

The Playground: Directory Resource package.

Documentation

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 CMS API.

See package.json requirements.

Install npm.

npm install

Build the documentation to generate the swagger.json configuration.

npm run docs

Documentation

Installation

You can install the package via composer:

composer require gammamatrix/playground-directory-resource

Configuration

All options are disabled by default.

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

You can publish the config file with:

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

Cloc

composer cloc
➜  playground-directory-resource git:(develop) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .

PHPStan

Tests at level 9 on:

  • config/
  • lang/
  • routes/
  • src/
  • tests/Feature/
  • tests/Unit/
composer analyse

Coding Standards

composer format

Testing

composer test --parallel

Changelog

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

License

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