gammamatrix/playground-lead-api

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

dev-develop / 73.x-dev 2024-08-17 18:06 UTC

Requires

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

Requires (Dev)

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

MIT

• Jeremy Postlethwaite

• laravel
• playground
• lead
• gammamatrix

README

The playground-lead-api Laravel package.

This package provides an API for interacting with the Playground Lead, a Campaign Sales Management tool.

If you need a UI, then use Playground Lead Resource, which provides a Blade UI.

Documentation

Read more on using Playground Lead API at Read the Docs: Playground Documentation.

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 Lead 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-api

Configuration

All options are disabled by default.

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

You can publish the config file with:

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

Cloc

composer cloc

➜  playground-lead-api git:(feature/GH-1) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .
     618 text files.
     446 unique files.
     173 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.61 s (725.4 files/s, 117450.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             5              0              0          35543
PHP                            322           2433           3998          16335
YAML                           112              5              0          13544
XML                              3              0              7            215
Markdown                         3             37              0             85
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           446           2478           4005          65734
-------------------------------------------------------------------------------

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.