caiocesar173/laravel-utils

Utils Laravel Package

dev-main 2023-03-01 02:58 UTC

Requires

• php: ^8.0
• doctrine/dbal: ^3.4
• laravel/passport: ^11.2
• laravel/socialite: ^5.5
• laravel/ui: ^4.0
• lucascudo/laravel-pt-br-localization: ^1.2
• owen-it/laravel-auditing: ^13.0
• prettus/l5-repository: ^2.7
• spatie/laravel-sluggable: ^3.4
• spatie/laravel-translatable: ^6.0
• stevebauman/location: ^6.2
• watson/validating: ^7.0

Requires (Dev)

• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.3

MIT

• caiocesar173

README

Laravel Utils

This is a Laravel package which created to make your life easier. The package comes with most of everything you may need for develop large applications with less effort.

Considerations

• Laravel Utils comes with laravel-passport already setup.
• Login and CRUD for the User is implemented whith route middlewares.
• Permission system is implemented whith route middlewares.
• Laravel Utils comes with a status system defined.

Installation

1. Install the package via composer:

   composer require caiocesar173/laravel-utils

2. Publish owenit via the following command:

   php artisan vendor:publish --provider "OwenIt\Auditing\AuditingServiceProvider" --tag="config"

3. On your config/auth add the gurad api and place his driver as passport:

   'guards' => [
       ...
       'api' => [
           'driver' => 'passport',
           'provider' => 'users',
       ],
   ],

4. On your config/auth inside providers replace de default User Model (App\Models\User::class):

   'providers' => [
       ...
       'users' => [
           'driver' => 'eloquent',
           'model' => Caiocesar173\Utils\Entities\User::class,
       ],
   ],

5. Execute migrations via the following command:

   php artisan migrate

6. Setup laravel-passport via the following command:

   php artisan passport:install

7. Seed the database via the following command:

   php artisan db:seed
   

8. Done!

Language

Additionally, the package comes with the laravel-pt-BR-localization language support. To install it, just do:

1. Publish the translation

   php artisan vendor:publish --tag=laravel-pt-br-localization

2. On your config/app.php in locale replace de default en with:

   'locale' => 'pt-BR',

3. On your config/app.php in timezone replace de default UTC with:

   'timezone' => 'America/Sao_Paulo',

4. Done!

Social Login

On your config/services add the provider api and place his driver as passport:

'provider_name' => [
    client_id => env(PROVIDER_NAME_CLIENT_ID),
    client_secret => env(PROVIDER_NAME_CLIENT_SECRET),
    redirect => env(PROVIDER_NAME_URL_CALLBACK),
],

Envirement Varibles

The Varibles accepted on .env:

    #In case you olny want to use the classes inside the package set the UTILS_ONLY_CLASSES=TRUE
    UTILS_ONLY_CLASSES = FALSE
    UTILS_GEOLOC_ENABLE = TRUE #GeoLoc: locatins, coins, language and internet and phone zones