README

The Playground CRM is a package for Laravel applications.

Playground: Provide the CRM models for the Playground Client Relationship Management System.

Read more on using Playground: CRM at Read the Docs

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:

Migrations

All migrations are disabled by default.

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

NOTE: There are 5 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"

Cloc

composer cloc

➜  playground-crm git:(develop) ✗ composer cloc
      87 text files.
      82 unique files.
       6 files ignored.

github.com/AlDanial/cloc v 2.06  T=0.03 s (2445.8 files/s, 569035.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                            34              0              0          14514
PHP                             33            369            854           2480
XML                             10              0              7            392
YAML                             1              5              0            275
Markdown                         3             46              1            120
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                            82            423            862          17793
-------------------------------------------------------------------------------

PHPStan

Tests at level 10 on:

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

composer analyse

Coding Standards

composer format

Testing

Unit tests

composer test

Unit and feature tests

composer test-dev

Run unit and feature tests in parallel:

composer test-parallel

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.

gammamatrix / playground-crm

Maintainers

Details