README

Specially customized Laravel jetstream's scaffolding for Sneat admin Template. It'll not work with any other project.

Description

Laravel Jetstream is designed using Tailwind CSS and offers your choice of Livewire or Inertia scaffolding. We have removed the Tailwind CSS dependency and modified the Livewire scaffolding as per our template. Please note we have not provided Inertia scaffolding yet. This package only works with livewire scaffolding.

Sneat Laravel Jetstream is a lightweight laravel package that focuses on the VIEW side of Jetstream package installed in your Laravel application, so when a swap is performed, the Action, MODEL, CONTROLLER, Component and Action classes of your project is still 100% handled by Laravel development team with no added layer of complexity.

Table of Content

sneat-html-laravel-jetstream - Specially customized Laravel jetstream's scaffolding for Sneat admin Template. It'll not work with any other project.

Installation

Installing Jetstream

You may use Composer to install Jetstream into your new Laravel project:

composer require laravel/jetstream

If you choose to install Jetstream through Composer, you should run the jetstream:install Artisan command. This command accepts the name of the stack you prefer (livewire). You are highly encouraged to read through the entire documentation of Livewire before beginning your Jetstream project. In addition, you may use the --teams switch to enable team support:

Install Jetstream With Livewire

// without teams support

php artisan jetstream:install livewire

or

// with teams support

php artisan jetstream:install livewire --teams

Install Sneat Laravel Bootstrap Jetstream

Use Composer to install Sneat Jetstream into your new Laravel project as dev dependency:

composer require themeselection/sneat-html-laravel-jetstream --dev

Regardless how you install Jetstream, Sneat Laravel Bootstrap Jetstream commands are very similar to that

of Jetstream as it accepts the name of the stack you would like to swap (livewire).

It is important you install and configure Laravel Jetstream before performing a swap.

You are highly encouraged to read through the entire documentation of Jetstream

before beginning your Sneat Laravel Jetstream project. In addition, you may use the --teams switch to swap team assets just like you would in Jetstream:

// without teams support

php artisan jetstream_sneat:swap livewire


or

// with teams support

php artisan jetstream_sneat:swap livewire --teams

This will publish overrides to enable Bootstrap like the good old days!

Finalizing The Installation

After installing Sneat jetstream and swapping Jetstream resources, remove tailwindCSS and its dependencies if any from your package.json and then install and build your NPM dependencies and migrate your database:

npm install && npm run build

or  

yarn && yarn build


php artisan migrate

Extras

Pagination

It is also important to point out that Laravel still includes pagination views built using Bootstrap CSS. To use these views instead of the default Tailwind views, you may call the paginator's useBootstrap method within your AppServiceProvider:

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Pagination\Paginator;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        //
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Paginator::useBootstrap();
    }
}

Credits

This packages is built on top of Jetstream & Jetstrap

License

Sneat Jetstream is open-sourced software licensed under the MIT license.

themeselection / sneat-html-laravel-jetstream

Maintainers

Details