gammamatrix/playground-crm-api

Playground: Provides an API, without a UI for interacting with Playground CRM, a Client Relationship Management System for Laravel applications.

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

Requires

• php: ^8.2
• gammamatrix/playground: *
• gammamatrix/playground-auth: *
• gammamatrix/playground-crm: *
• gammamatrix/playground-http: *

Requires (Dev)

• gammamatrix/playground-test: *
• laravel/sanctum: ^4.0

MIT

• Jeremy Postlethwaite

• crm
• laravel
• playground
• gammamatrix

README

The Playground: CRM API 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-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
> cloc --exclude-dir=node_modules,output,vendor .
     316 text files.
     228 unique files.
      89 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.33 s (688.1 files/s, 103018.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             5              0              0          18356
PHP                            154           1179           1945           6795
YAML                            62              5              0           5495
XML                              3              0              7            215
Markdown                         3             37              0             85
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           228           1224           1952          30958
-------------------------------------------------------------------------------

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.