readme.md

Installation

composer require levaral-dev/core:dev-master

Commands

This command will generate base structure.

levaral:structure

This command will generate all the base classes of the models. Argument {model} will generate base classes for the specific model

levaral:models {model?}

This command will generate all the [api routes/api services] in plain javascript objects

levaral:api-js

This command will generate action class in Actions folder.

make:action {namespace}

for e.g

make:action 'User\Profile\GetDetail'

This command will generate model and the base classes in Domain folder.

make:model {namespace}

This command will scan all the Actions in Api folder and generate test classes

levaral:generate-test

This command will generate expo token table and model. Those tokens will be used to send push notifications. This package also has expo push notification channel i.e ExpoPushNotification

levaral:user-expo-tokens

This command will generate language files for frontend

levaral:generate-language-json

Action Routes

Action routes can be defined in any laravel route files like (web.php, api.php etc..), when using action routes you don't need to define named route, it will be generated automatically.

for e.g

Action::get('get-detail', \App\Http\Actions\User\GetDetail::class); // route name User:GetDetail
Action::post('get-detail', \App\Http\Actions\User\PostDetail::class); // route name User:PostDetail
Action::post('get-detail', \App\Http\Actions\User\PostDetail::class); // route name User:PostDetail
Action::post('get-detail', \App\Http\Actions\User\Profile\GetDetail::class); // route name User:Profile:PostDetail

Notification Channels

MailChannel

Laravel already providing the mail channel, Levaral mail channel extends the Laravel mail channel and provide some more feature. Levaral mail channel will track the mail logs like sent, opened, clicked, failed etc.. For now Levaral mail channel only support the mail logs of Mailgun and Sendgrid

How to install

Run following command to generate mail log table and MailLog model

levaral:maillog:table

To use Levaral mail channel add following code in register method of Providers\AppServiceProvider.php. That's it now your all mail notifications will use Levaral Core MailChannel

$this->app->bind(
    \Illuminate\Notifications\Channels\MailChannel::class,
    \Levaral\Core\Channels\MailChannel::class
);

Register routes for MailGun or Sendgrid web hook, you need to except those routs in VerifyCsrfToken middleware

Action::post('/mailgun-webhook', Levaral\Core\Action\MailLog\PostMailGunHook::class);
Action::post('/sendgrid-webhook', Levaral\Core\Action\MailLog\PostSendGridHook::class);

ExpoPushNotification

add toExpo to your notification class for e.g

function toExpo()
{
    return [
        'body' => 'Test Message'
    ];
}

If you include to in above array then the notification will be send to only that particular device, if not then it will send the notifications to only that notifiable object devices, which are in the user_expo_tokens table

MailLogs

Maillogs will track your all out going mail and sent, opened and clicked events. For now it supports only Mailgun and Sendgrid

Run following command to create maillog table

levaral:maillog:table

Add action route to laravel route file.

Action::post('mailgun-webhook', Laravel\Core\Action\MailLog\PostMailGunHook::class); // route for mailgun webhook
Action::post('sendgrid-webhook', Laravel\Core\Action\MailLog\PostSendGridHook::class); // route for sendgrid webhook

To send mail notification with maillog history.

Util::notify($notifiable, $notificationObject, $model)