README

The Playground: CRM 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

• Preview swagger.json on the Swagger Editor UI.
• Preview swagger.json on the Redocly Editor UI.

Installation

You can install the package via composer:

composer require gammamatrix/playground-crm-resource

Configuration

All options are disabled by default.

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

You can publish the config file with:

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

Cloc

composer cloc

➜  playground-crm-resource git:(develop) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .
     336 text files.
     241 unique files.
      96 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.37 s (656.1 files/s, 101701.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             5              0              0          18420
PHP                            157           1381           1987           7585
YAML                            52              5              0           5120
Blade                           20            126              7           2365
XML                              3              0              7            215
Markdown                         3             37              0             85
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           241           1552           2001          33802
-------------------------------------------------------------------------------

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.