salt/core

Netlify - Package Documentation Home

This package houses core logic, templates and components used by Laravel applications built by the Salt team.

It has the following features:

• Custom collection traits
• A Mandrill mail sender service
• A dynamic menu builder
• Permissions and roles
• Settings

Installation

You can install the package via composer:

composer require salt/core

You can publish and run the migrations with:

php artisan vendor:publish --tag="core-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="core-config"

This is the contents of the published config file:

use App\Options\RoleOptions;
use App\Options\PermissionOptions;

return [
    'mail' => array(
        'mandrill' => array(
            'key' => env('MANDRILL_KEY', ''),
            'template' => env('MANDRILL_TEMPLATE', '')
        )
    ),
    'permissions' => PermissionOptions::$permissionsArray,
    'roles' => RoleOptions::$rolesArray,
    'url' => env('APP_URL', ''),
    'user' => \App\Models\User::class
];

Documentation

View the documentation for this package here

Testing

composer test

Releasing a new version

To release a new version, first create a tag on the main branch with the new version number. E.g "1.0.1":

git tag -a 1.0.1 -m "Release version 1.0.1"

Then push that tag up to GitHub:

git push origin 1.0.1

A new version will automatically be created on packagist which will then be available for installation.

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Salt
• All Contributors