README

A Laravel Blade Template with Sanctum Authentication built in.

Based on the Blade & Breeze Starter Kit provided with Laravel versions before Laravel 12.

Primarily used for teaching purposes at North Metropolitan TAFE.

Built With

Editor of choice

Repo Stats

(🔝 Back to top)

Description

A starter kit for Laravel based on Laravel's Blade templating engine, TailwindCSS v4, HyperUI components and FontAwesome Free icons.

It contains three sections:

• Web:
  • Static Layout, Controller and Pages
• Client:
  • Authenticated User Layout and Pages
• Admin:
  • Administration Layout, Controller and Pages

The project is developed as a re-write of the "Retro Blade Kit" and "Base Blade Kit" also by Adrian Gould.

It provides a base template for the creation of a "SaaS" style application, omitting sections that may tie to a specific vendor such as a payment system.

(🔝 Back to top)

Table of Contents

• Badges
• Description
• Installation
• Extending the Kit
• Screenshots
• Tests
• Credits
• Contact
• Licence

Installation

Remember to run composer install, composer update, php artisan migrate, php artisan key:generate to make sure a key is generated, all tables are created, and packages correctly installed.

Alternatively, you may use composer setup to install all packages, set a key, migrate and other common Laravel setup steps (using pnpm for Node.js package management). Using composer setup-npm will perform the same process but using npm for package management.

Via Laravel Herd

One-click install a new application using this starter kit through Laravel Herd:

Via the Laravel Installer

Create a new Laravel application using this starter kit through the official Laravel Installer:

  laravel new my-app --using=adygcode/blade-sanctum-kit

to use PNPM in place of NPM use:

  laravel new my-app --pnpm --using=adygcode/blade-sanctum-kit

To install with Pest, PNPM, Livewire, initialise a git repo, SQLite, ... (Typed in on a single command line):

  laravel new my-app --pnpm --git --database=sqlite \
    --pest --using=adygcode/blade-sanctum-kit 

In either case, you must replace my-app with the name of your project, using kebab-case. For example duck-quack-paddle.

(🔝back to top)

Post setup

The steps for post installation will depend on if you are a student.

What is .env.example?

The .env.example is a base configuration for the installed application.

The mail configuration in the .env.example for MailPit is set to port 2525. Change to 1025 for the default MailPit port in the .env.example and your generated .env file.

When deploying to anything beyond a development environment ensure that any secrets are removed from the .env.example.

Finishing the Set-up

Remember that app-name is the name of the application you used when creating the project. It will be replaced by the project's name, for example my-big-laravel-app.

Switch into the project folder:

cd app-name

Execute a composer and npm update to ensure latest versions of packages, bug fixes or security fixes applied:

For NPM:

composer update
npm update

For PNPM:

composer update
pnpm update

Execute the following steps to configure your development environment:

cp .env.dev .env
php artisan key:generate
php artisan migrate:fresh --seed

At this point you should be able to execute the development server.

Development Servers

We have expanded the default composer run scripts provided with Laravel.

We have included:

• dev for general use, no MailPit
• dev-win for Windows users, with MailPit
• dev-linux, for macOS and Linux uses, with MailPit and Log Watching

Dev

Executes three scripts in parallel using the concurrently package.

• php artisan serve
• php artisan queue:listen --tries=1
• npm run dev

composer run dev

Dev-Win

This is for Windows users who are not using WSL or Docker.

Executes four scripts in parallel using the concurrently package.

• php artisan serve
• php artisan queue:listen --tries=1
• npm run dev
• mailpit --smtp=0.0.0.0:2525

composer run dev-win

Dev-Linux

This is for Linux and macOS users.

Ensure you have installed MailPit and Pail on your macOS/Linux system.

Executes five scripts in parallel using the concurrently package.

• php artisan serve
• php artisan queue:listen --tries=1
• npm run dev
• mailpit --smtp=0.0.0.0:2525
• php artisan pail --timeout=0

composer run dev-linux

PhpStan

PHPStan is a static analysis package for PHP. It has been wrapped for Laravel use.

Installation details are in the Extending Kit section.

The command executes:

• phpstan analyse --memory-limit=2G

composer run phpstan

(🔝 Back to top)

Extending Kit

If you wish to add packages for further functionality, then follow the usual documentation from each of their sites.

Dev	Prod	Item	Purpose
✔️	✔️		Laravel based dynamic pages with minimal JS
✔️	✔️		Roles and Permissions
✔️	✔️️		Application performance tracking and debugging. May be resource usage heavy
✔️	❌		In browser debug bar
✔️	❌		Debugging without dump and die
✔️	❌		Static analysis of code
✔️	❌		Opinionated code formatting

Installation of Packages

After completing an installation with the starter kit, you may want to update or add extra packages.

Updating is always a good idea before getting into the development process. And it should also be completed whilst development is progressing, but never on the main branch.

Adding additional packages will occur, usually as the development process is completed, again never on the main branch.

When updating or adding any package make sure you immediately run your tests to make sure nothing has got broken in the upgrade/addition process.

Static Analysis for Laravel

Use during development.

composer require larastan/larastan --dev

The project has a base phpstan.neon configuration file in the project's root folder.

Pint Opinionated Code Formatting and Linter

Use during development

composer require laravel/pint --dev

Laradumps

Use during development only.

composer require laradumps/laradumps --dev

Debug Bar

Use during development only.

composer require barryvdh/laravel-debugbar --dev

Telescope

To use during development only:

composer require laravel/telescope --dev

If you wish to use this for development and production, remove the --dev:

composer require laravel/telescope

Livewire 4.0 BETA

composer require laravel/livewire

Spatie Permission

composer require spatie/laravel-permission

(🔝 Back to top)

Updating Packages

If you wish to make sure that the basics are complete, and upgrades are also completed then the following may assist...

Dry Run Updates

Before doing so, do a dry run to see what is updated:

composer update --dry-run
npm update --dry-run

Replace npm with pnpm when using pnpm.

Composer Package Updates

You may update individually using commands such as those below:

composer update laravel/laravel
composer update laravel/sanctum
composer update --dev roave/security-advisories:dev-latest
composer update --dev laravel/breeze
composer update --dev laravel/pint
composer update --dev pestphp/pest
composer update --dev pestphp/pest-plugin-laravel

Or you may attempt a complete update using:

composer update

Node.js Package Updates

We have shown how to check for updates to the Node.js packages, and likewise you may update all the packages using a single command:

npm update

or

pnpm update

(🔝 Back to top)

Screenshots

Below are sample pages from the kit.

General Welcome/Home Page

Authenticated User Dashboard

Admin Dashboard

About Page

Privacy Policy Page

(🔝 Back to top)

Tests

TBD

(🔝 Back to top)

Credits

This template is built using:

• Font Awesome. (n.d.). Fontawesome.com. https://fontawesome.com
• Laravel - The PHP Framework For Web Artisans. (2011). Laravel.com. https://laravel.com
• Laravel Bootcamp - Learn the PHP Framework for Web Artisans. (n.d.). Bootcamp.laravel.com. https://bootcamp.laravel.com/
• PHP: Hypertext Preprocessor. (n.d.). Www.php.net. https://php.net
• Professional README Guide. (n.d.). Coding-Boot-Camp.github.io. Retrieved April 15, 2024, from https://coding-boot-camp.github.io/full-stack/github/professional-guide
• TailwindCSS. (2023). Tailwind CSS - Rapidly build modern websites without ever leaving your HTML. Tailwindcss.com. https://tailwindcss.com/
• Free Open Source Tailwind CSS v4 Components | HyperUI. (2025). HyperUI. https://www.hyperui.dev/
• Shields.io. (2025). Shields.io. https://shields.io/
• Simple Icons. (2025). Simpleicons.org. https://simpleicons.org/?q=simple
• Roave/SecurityAdvisories: Security advisories as a simple composer exclusion list, updated daily. (2025). GitHub. https://github.com/Roave/SecurityAdvisories

(🔝 Back to top)

Contact

Adrian Gould: Lecturer ( ASL1), North Metropolitan TAFE, Perth WA, Australia.

• GitHub Pages: https://adygcode.github.io
• GitHub Repos: https://github.com/AdyGCode
• Starter Kit Repo: Blade Sanctum Starter Kit

(🔝 Back to top)

Licence

The Laravel "Blade with Sanctum" Starter Kit is open-sourced software licensed under the MIT license.

(🔝 Back to top)