gammamatrix/playground-crm

Playground: Provide the CRM models for the Playground Content Management System.

dev-develop / 73.x-dev 2024-04-03 06:19 UTC

Requires

• php: ^8.2
• gammamatrix/playground: 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

Suggests

• gammamatrix/playground-crm-api: Provides an API, without a UI, to interact with the models provided in this package.
• gammamatrix/playground-crm-resource: Provides a resource API and optional Blade UI to interact with the models provided in this package.

MIT

• Jeremy Postlethwaite

• crm
• laravel
• playground
• gammamatrix

README

The Playground CRM is a package for Laravel applications.

This application provides the models to use the Playground CRM, a Client Relationship Manager.

Read more on using Playground CRM at Read the Docs: Playground Documentation.

Installation

NOTE: This package is required by:

• Playground CRM API: API without UI
• Playground CRM Resource: API with UI

Install this package, with composer, to get access to the CRM Models:

composer require gammamatrix/playground-crm

artisan:about

Playground CRM provides information in the artisan about command.

Configuration

Migrations are disabled by default. This package may sometimes be installed where another system handles the migrations.

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

You can publish the config file with:

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

Environment Variables

env()	config()	Default
PLAYGROUND_CRM_ABOUT	playground-crm.about	true
PLAYGROUND_CRM_LOAD_MIGRATIONS	playground-crm.load.migrations	false

• The loading option for migrations does not take effect if the migrations have been exported to your app. The control for loading is handled in the package ServiceProvider.

Models

This package includes factories, models and migrations for:

• Clients
• Contacts
• Locations
• Organizations
• Peoples

Migrations

All migrations are disabled by default.

See the contents of the published config file: database/migrations

• NOTE: There are 4 tables that will be created, they do have indexes and unique constraints defined; however, this release does not have the foreign key constraint migrations included at this time.

You can publish the migrations file with:

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

PHPStan

Tests at level 9 on:

• config/
• database/
• src/
• tests/Feature/
• tests/Unit/

composer analyse

Coding Standards

composer format

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Jeremy Postlethwaite

License

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