gammamatrix/playground-lead-resource

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

dev-develop / 73.x-dev 2024-08-17 19:30 UTC

Requires

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

Requires (Dev)

• gammamatrix/playground-login-blade: *
• gammamatrix/playground-site-blade: *
• gammamatrix/playground-test: *

MIT

• Jeremy Postlethwaite

• laravel
• playground
• lead
• gammamatrix
• playground-blade

README

The Playground: Lead 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-lead-resource

Configuration

All options are disabled by default.

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

You can publish the config file with:

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

Cloc

composer cloc

➜  playground-lead-resource git:(develop) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .
     936 text files.
     732 unique files.
     205 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.97 s (752.8 files/s, 87447.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                           250              0              0          39291
PHP                            325           2845           4033          17996
YAML                           112              5              0          13654
Blade                           38            235              7           6609
XML                              3              0              7            215
Markdown                         3             37              0             84
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           732           3125           4047          77861
-------------------------------------------------------------------------------

PHPStan

Tests at level 9 on:

• config/
• 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.