README

The Playground: CRM API package.

Documentation

OpenAPI

This application provides OpenAPI documentation: openapi.yaml.

• The endpoint models support locks, trash with force delete, restoring, revisions and more.
• Index endpoints support advanced query filtering.

OpenAPI API Documentation is built with npm using Redocly.

• npm is only needed to generate documentation and is not needed to operate the Playground: CRM API API.

See package.json requirements.

Install npm.

npm install

Build the documentation to generate the openapi.yaml configuration.

npm run docs

Documentation

• Preview openapi.yaml on the Redocly Editor UI.

Installation

You can install the package via composer:

composer require gammamatrix/playground-crm-api

Configuration

All options are disabled by default.

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

You can publish the config file with:

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

Cloc

composer cloc

➜  playground-crm-api git:(develop) ✗ composer cloc
     392 text files.
     382 unique files.
      96 files ignored.

github.com/AlDanial/cloc v 2.06  T=0.14 s (2671.6 files/s, 297184.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                           161              0              0          20582
YAML                            54              5              0          11280
PHP                            153           1452           1941           6265
XML                             10              0              7            798
Markdown                         3             40              0            108
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           382           1500           1948          39045
-------------------------------------------------------------------------------

PHPStan

Tests at level 10 on:

• config/
• routes/
• src/
• tests/Feature/
• tests/Unit/

composer analyse

Coding Standards

composer format

Testing

Run unit tests:

composer test

Run 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.

License

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