gammamatrix / playground-lead-resource
Playground: Provides an API and a Blade UI for interacting with Playground Lead, a sales campaign management tool for Laravel applications.
Requires
- php: ^8.1
- gammamatrix/playground-auth: dev-develop|dev-master|dev-feature/*|^73.0@dev|^73.0
- gammamatrix/playground-http: dev-develop|dev-master|dev-feature/*|^73.0@dev|^73.0
- gammamatrix/playground-lead: dev-develop|dev-master|dev-feature/*|^73.0@dev|^73.0
Requires (Dev)
- gammamatrix/playground-test: dev-develop|dev-master|dev-feature/*|^73.0@dev|^73.0
- laravel/sanctum: ^4.0
This package is auto-updated.
Last update: 2024-05-04 18:23:25 UTC
README
The playground-lead-resource
Laravel package.
This package provides an Resource 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 Resource at Read the Docs: Playground 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 Resource Documentation is built with npm.
- npm is only needed to generate documentation and is not needed to operate the LEAD Resource.
See package.json requirements.
Install npm.
npm install
Build the documentation to generate the swagger.json configuration.
npm run docs
Documentation
Installation
You can install the package via composer:
composer require gammamatrix/playground-lead-resource
artisan about
Playground provides information in the artisan about
command.
Configuration
You can publish the config file with:
php artisan vendor:publish --provider="Playground\Lead\Resource\ServiceProvider" --tag="playground-config"
All routes are enabled by default. They may be disabled via enviroment variable or the configuration.
See the contents of the published config file: config/playground-lead-resource.php
You can publish the routes file with:
php artisan vendor:publish --provider="Playground\Lead\Resource\ServiceProvider" --tag="playground-routes"
- The routes while be published in a folder at
routes/playground-lead-resource
Environment Variables
If you are unable or do not want to publish configuration files for this package, you may override the options via system environment variables.
Information on environment variables is available on the wiki for this package
Migrations
This package requires the migrations in playground-lead a Laravel package.
PHPStan
Tests at level 9 on:
config/
database/
routes/
src/
tests/Feature/
tests/Unit/
composer analyse
Coding Standards
composer format
Tests
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.