mohamadtsn/laravel-supernova

it's a basic Management panel for laravel application

3.0.3 2023-06-24 06:38 UTC

Requires

• php: ^8.0|^8.1
• biscolab/laravel-recaptcha: ^6.0
• illuminate/auth: ^10.0
• illuminate/routing: ^10.0
• illuminate/support: ^10.0
• mohamadtsn/laravel-repository: ^2.0
• realrashid/sweet-alert: ^7.0
• spatie/laravel-permission: ^5.10

MIT

• Mohammad Borzoyi

• php
• laravel
• admin-panel
• laravel admin
• laravel-admin-panel
• laravel8
• laravel8-package
• laravel-supernova
• laravel-metronic

README

Give a professional and powerful management panel as your Laravel App gift. 🎁

Installation: ⬇️

composer require mohamadtsn/laravel-supernova

configuration: ⚙️

Publishing Base Vendor Files

php artisan supernova:publish [tags] --force

Tag list:

• supernova-resources
• supernova-base-resources
• supernova-config
• supernova-migrations
• supernova-virtual-host-routes
• supernova-recaptcha-config
• supernova-basic-routes

Publishing Custom Vendor File

php artisan supernova:publish [tags] --force

Change locale to fa in config/app.php

'locale' => 'fa',

Change Parent Class User Model:

Put this in App\Models\User.php

use Mohamadtsn\Supernova\Models\User as SupernovaUser; // use supernova User Model
use Mohamadtsn\Supernova\Classes\Traits\PermissionWrapper;
class User extends SupernovaUser
{
    use HasApiTokens, HasFactory, Notifiable, PermissionWrapper;
    // other class methods
}

Add level to fillable fields in App\Models\User.php.

protected $fillable = [
    'level',
];

Add these seeders call in Database\Seeders\DatabaseSeeder.php in run() method:

class DatabaseSeeder extends Seeder
{
    public function run()
    {
        // Other seeders call
        // You add seeders
        $this->call(UserSeeder::class); // #1
        $this->call(PermissionSeeder::class); // #2
    }
}

Add these into guards section in config/auth.php:

'guards' => [
    // other guard
    'admin' => [
        'driver' => 'session',
        'provider' => 'users',
    ],
],

Put these in app/Http/Kernel.php like below:

use App\Http\Middleware\Panel\CheckPermission; // use Middleware class CheckPermission

class Kernel extends HttpKernel
{
    protected $routeMiddleware = [
        // other routeMiddleware
        'permission' => CheckPermission::class, // add CheckPermission::class on this section
    ];
}

Change these in App/Http/Middleware/Authenticate.php in redirectTo method like below:

protected function redirectTo($request)
{
        if ($request->expectsJson()) {
            return response()->json([
                'title' => 'access denied',
                'text' => 'unauthorized ...!',
                'type' => 'error'
            ], Response::HTTP_FORBIDDEN);
        }
        return route('panel.login');
}

add admin panel routes file routes/admin.php to App/Providers/RouteServiceProvider.php in boot() method

IMPORTANT!! Be sure to add before `web.php`.

Look carefully:

For Run project With Virtual Domain:

public function boot()
{
    $this->routes(function () {
        // other routes file
        Route::middleware('web')
                ->namespace($this->namespace)
                ->domain(config('supernova.management_url'))
                ->group(base_path('routes/admin.php')); // #1 add admin panel routes (admin.php)
        
        Route::middleware('web')
                ->namespace($this->namespace)
                ->domain(config('app.url'))
                ->group(base_path('routes/web.php')); // #2 web.php routes
    });
}

For Run project With Cli Serving (php artisan serve):

public function boot()
{
    $this->routes(function () {
        // other routes file
        Route::middleware('web')
                ->namespace($this->namespace)
                ->group(base_path('routes/admin.php')); // #1 add admin panel routes (admin.php)
        
        Route::middleware('web')
                ->namespace($this->namespace)
                ->domain(config('app.url'))
                ->group(base_path('routes/web.php')); // #2 web.php routes
    });
}

Setup Schema:

1. Set database config connection in .env file
2. Migrate and seeding using the following commands:

php artisan migrate:fresh --seed        // "Associated with" Drop All Tables & Migrate and seeding
"Or"
php artisan migrate --seed              // "Without" Drop All Tables & Migrate and seeding

re-generate composer autoload:

 composer dump-autoload

Usage

Method #1 ====> Setup with virtual host

• Build a virtual subdomain with name Management

  • Example:
    • origin domain => example.test // Main URL
    • subdomain domain => management.example.test // Admin Panel URL

• add param Admin Panel URL to env file with name APP_MANAGEMENT_URL like below:

  APP_URL= http://shop.test
  APP_MANAGEMENT_URL= http://management.shop.test

• add config Admin Panel URL to config/supernova.php file with name management_url like below:

  return [
      // other configs
      'management_url' => env('APP_MANAGEMENT_URL', 'http://management.example.test'),
  ]

• Login to Panel management.example.test/login

• Dashboard Panel management.example.test/

Method #2 ====> Setup without virtual host

1. publish basic routes:

php artisan supernova:publish supernova-basic-routes --force

1. serve app with command:

php artisan serve

1. Tip: You have access to Supernova Panel Routes only with Prefix panel
2. Go to 127.0.0.1:8000/panel/login

Login to Panel

• Email: [e-mail]
• Password: supernova@123

Enjoy it 👋