Laravel MCP Companion

# Starter Kits - [Introduction](#introduction) - [Creating an Application Using a Starter Kit](#creating-an-application) - [Available Starter Kits](#available-starter-kits) - [React](#react) - [Vue](#vue) - [Livewire](#livewire) - [Starter Kit Customization](#starter-kit-customization) - [React](#react-customization) - [Vue](#vue-customization) - [Livewire](#livewire-customization) - [Authentication](#authentication) - [Enabling and Disabling Features](#enabling-and-disabling-features) - [Customizing User Creation and Password Reset](#customizing-actions) - [Two-Factor Authentication](#two-factor-authentication) - [Rate Limiting](#rate-limiting) - [WorkOS AuthKit Authentication](#workos) - [Inertia SSR](#inertia-ssr) - [Community Maintained Starter Kits](#community-maintained-starter-kits) - [Frequently Asked Questions](#faqs) <a name="introduction"></a> ## Introduction To give you a head start building your new Laravel application, we are happy to offer [application starter kits](https://laravel.com/starter-kits). These starter kits give you a head start on building your next Laravel application, and include the routes, controllers, and views you need to register and authenticate your application's users. The starter kits use [Laravel Fortify](/docs/{{version}}/fortify) to provide authentication. While you are welcome to use these starter kits, they are not required. You are free to build your own application from the ground up by simply installing a fresh copy of Laravel. Either way, we know you will build something great! <a name="creating-an-application"></a> ## Creating an Application Using a Starter Kit To create a new Laravel application using one of our starter kits, you should first [install PHP and the Laravel CLI tool](/docs/{{version}}/installation#installing-php). If you already have PHP and Composer installed, you may install the Laravel installer CLI tool via Composer: ```shell composer global require laravel/installer ``` Then, create a new Laravel application using the Laravel installer CLI. The Laravel installer will prompt you to select your preferred starter kit: ```shell laravel new my-app ``` After creating your Laravel application, you only need to install its frontend dependencies via NPM and start the Laravel development server: ```shell cd my-app npm install && npm run build composer run dev ``` Once you have started the Laravel development server, your application will be accessible in your web browser at [http://localhost:8000](http://localhost:8000). <a name="available-starter-kits"></a> ## Available Starter Kits <a name="react"></a> ### React Our React starter kit provides a robust, modern starting point for building Laravel applications with a React frontend using [Inertia](https://inertiajs.com). Inertia allows you to build modern, single-page React applications using classic server-side routing and controllers. This lets you enjoy the frontend power of React combined with the incredible backend productivity of Laravel and lightning-fast Vite compilation. The React starter kit utilizes React 19, TypeScript, Tailwind, and the [shadcn/ui](https://ui.shadcn.com) component library. <a name="vue"></a> ### Vue Our Vue starter kit provides a great starting point for building Laravel applications with a Vue frontend using [Inertia](https://inertiajs.com). Inertia allows you to build modern, single-page Vue applications using classic server-side routing and controllers. This lets you enjoy the frontend power of Vue combined with the incredible backend productivity of Laravel and lightning-fast Vite compilation. The Vue starter kit utilizes the Vue Composition API, TypeScript, Tailwind, and the [shadcn-vue](https://www.shadcn-vue.com/) component library. <a name="livewire"></a> ### Livewire Our Livewire starter kit provides the perfect starting point for building Laravel applications with a [Laravel Livewire](https://livewire.laravel.com) frontend. Livewire is a powerful way of building dynamic, reactive, frontend UIs using just PHP. It's a great fit for teams that primarily use Blade templates and are looking for a simpler alternative to JavaScript-driven SPA frameworks like React and Vue. The Livewire starter kit utilizes Livewire, Tailwind, and the [Flux UI](https://fluxui.dev) component library. <a name="starter-kit-customization"></a> ## Starter Kit Customization <a name="react-customization"></a> ### React Our React starter kit is built with Inertia 2, React 19, Tailwind 4, and [shadcn/ui](https://ui.shadcn.com). As with all of our starter kits, all of the backend and frontend code exists within your application to allow for full customization. The majority of the frontend code is located in the `resources/js` directory. You are free to modify any of the code to customize the appearance and behavior of your application: ```text resources/js/ ├── components/ # Reusable React components ├── hooks/ # React hooks ├── layouts/ # Application layouts ├── lib/ # Utility functions and configuration ├── pages/ # Page components └── types/ # TypeScript definitions ``` To publish additional shadcn components, first [find the component you want to publish](https://ui.shadcn.com). Then, publish the component using `npx`: ```shell npx shadcn@latest add switch ``` In this example, the command will publish the Switch component to `resources/js/components/ui/switch.tsx`. Once the component has been published, you can use it in any of your pages: ```jsx import { Switch } from "@/components/ui/switch" const MyPage = () => { return ( <div> <Switch /> </div> ); }; export default MyPage; ``` <a name="react-available-layouts"></a> #### Available Layouts The React starter kit includes two different primary layouts for you to choose from: a "sidebar" layout and a "header" layout. The sidebar layout is the default, but you can switch to the header layout by modifying the layout that is imported at the top of your application's `resources/js/layouts/app-layout.tsx` file: ```js import AppLayoutTemplate from '@/layouts/app/app-sidebar-layout'; // [tl! remove] import AppLayoutTemplate from '@/layouts/app/app-header-layout'; // [tl! add] ``` <a name="react-sidebar-variants"></a> #### Sidebar Variants The sidebar layout includes three different variants: the default sidebar variant, the "inset" variant, and the "floating" variant. You may choose the variant you like best by modifying the `resources/js/components/app-sidebar.tsx` component: ```text <Sidebar collapsible="icon" variant="sidebar"> [tl! remove] <Sidebar collapsible="icon" variant="inset"> [tl! add] ``` <a name="react-authentication-page-layout-variants"></a> #### Authentication Page Layout Variants The authentication pages included with the React starter kit, such as the login page and registration page, also offer three different layout variants: "simple", "card", and "split". To change your authentication layout, modify the layout that is imported at the top of your application's `resources/js/layouts/auth-layout.tsx` file: ```js import AuthLayoutTemplate from '@/layouts/auth/auth-simple-layout'; // [tl! remove] import AuthLayoutTemplate from '@/layouts/auth/auth-split-layout'; // [tl! add] ``` <a name="vue-customization"></a> ### Vue Our Vue starter kit is built with Inertia 2, Vue 3 Composition API, Tailwind, and [shadcn-vue](https://www.shadcn-vue.com/). As with all of our starter kits, all of the backend and frontend code exists within your application to allow for full customization. The majority of the frontend code is located in the `resources/js` directory. You are free to modify any of the code to customize the appearance and behavior of your application: ```text resources/js/ ├── components/ # Reusable Vue components ├── composables/ # Vue composables / hooks ├── layouts/ # Application layouts ├── lib/ # Utility functions and configuration ├── pages/ # Page components └── types/ # TypeScript definitions ``` To publish additional shadcn-vue components, first [find the component you want to publish](https://www.shadcn-vue.com). Then, publish the component using `npx`: ```shell npx shadcn-vue@latest add switch ``` In this example, the command will publish the Switch component to `resources/js/components/ui/Switch.vue`. Once the component has been published, you can use it in any of your pages: ```vue <script setup lang="ts"> import { Switch } from '@/Components/ui/switch' </script> <template> <div> <Switch /> </div> </template> ``` <a name="vue-available-layouts"></a> #### Available Layouts The Vue starter kit includes two different primary layouts for you to choose from: a "sidebar" layout and a "header" layout. The sidebar layout is the default, but you can switch to the header layout by modifying the layout that is imported at the top of your application's `resources/js/layouts/AppLayout.vue` file: ```js import AppLayout from '@/layouts/app/AppSidebarLayout.vue'; // [tl! remove] import AppLayout from '@/layouts/app/AppHeaderLayout.vue'; // [tl! add] ``` <a name="vue-sidebar-variants"></a> #### Sidebar Variants The sidebar layout includes three different variants: the default sidebar variant, the "inset" variant, and the "floating" variant. You may choose the variant you like best by modifying the `resources/js/components/AppSidebar.vue` component: ```text <Sidebar collapsible="icon" variant="sidebar"> [tl! remove] <Sidebar collapsible="icon" variant="inset"> [tl! add] ``` <a name="vue-authentication-page-layout-variants"></a> #### Authentication Page Layout Variants The authentication pages included with the Vue starter kit, such as the login page and registration page, also offer three different layout variants: "simple", "card", and "split". To change your authentication layout, modify the layout that is imported at the top of your application's `resources/js/layouts/AuthLayout.vue` file: ```js import AuthLayout from '@/layouts/auth/AuthSimpleLayout.vue'; // [tl! remove] import AuthLayout from '@/layouts/auth/AuthSplitLayout.vue'; // [tl! add] ``` <a name="livewire-customization"></a> ### Livewire Our Livewire starter kit is built with Livewire 3, Tailwind, and [Flux UI](https://fluxui.dev/). As with all of our starter kits, all of the backend and frontend code exists within your application to allow for full customization. #### Livewire and Volt The majority of the frontend code is located in the `resources/views` directory. You are free to modify any of the code to customize the appearance and behavior of your application: ```text resources/views ├── components # Reusable Livewire components ├── flux # Customized Flux components ├── livewire # Livewire pages ├── partials # Reusable Blade partials ├── dashboard.blade.php # Authenticated user dashboard ├── welcome.blade.php # Guest user welcome page ``` #### Traditional Livewire Components The frontend code is located in the `resources/views` directory, while the `app/Livewire` directory contains the corresponding backend logic for the Livewire components. <a name="livewire-available-layouts"></a> #### Available Layouts The Livewire starter kit includes two different primary layouts for you to choose from: a "sidebar" layout and a "header" layout. The sidebar layout is the default, but you can switch to the header layout by modifying the layout that is used by your application's `resources/views/components/layouts/app.blade.php` file. In addition, you should add the `container` attribute to the main Flux component: ```blade <x-layouts.app.header> <flux:main container> {{ $slot }} </flux:main> </x-layouts.app.header> ``` <a name="livewire-authentication-page-layout-variants"></a> #### Authentication Page Layout Variants The authentication pages included with the Livewire starter kit, such as the login page and registration page, also offer three different layout variants: "simple", "card", and "split". To change your authentication layout, modify the layout that is used by your application's `resources/views/components/layouts/auth.blade.php` file: ```blade <x-layouts.auth.split> {{ $slot }} </x-layouts.auth.split> ``` <a name="authentication"></a> ## Authentication All starter kits use [Laravel Fortify](/docs/{{version}}/fortify) to handle authentication. Fortify provides routes, controllers, and logic for login, registration, password reset, email verification, and more. Fortify automatically registers the following authentication routes based on the features that are enabled in your application's `config/fortify.php` configuration file: | Route | Method | Description | | ---------------------------------- | ------ | ----------------------------------- | | `/login` | `GET` | Display login form | | `/login` | `POST` | Authenticate user | | `/logout` | `POST` | Log user out | | `/register` | `GET` | Display registration form | | `/register` | `POST` | Create new user | | `/forgot-password` | `GET` | Display password reset request form | | `/forgot-password` | `POST` | Send password reset link | | `/reset-password/{token}` | `GET` | Display password reset form | | `/reset-password` | `POST` | Update password | | `/email/verify` | `GET` | Display email verification notice | | `/email/verify/{id}/{hash}` | `GET` | Verify email address | | `/email/verification-notification` | `POST` | Resend verification email | | `/user/confirm-password` | `GET` | Display password confirmation form | | `/user/confirm-password` | `POST` | Confirm password | | `/two-factor-challenge` | `GET` | Display 2FA challenge form | | `/two-factor-challenge` | `POST` | Verify 2FA code | The `php artisan route:list` Artisan command can be used to display all of the routes in your application. <a name="enabling-and-disabling-features"></a> ### Enabling and Disabling Features You can control which Fortify features are enabled in your application's `config/fortify.php` configuration file: ```php use Laravel\Fortify\Features; 'features' => [ Features::registration(), Features::resetPasswords(), Features::emailVerification(), Features::twoFactorAuthentication([ 'confirm' => true, 'confirmPassword' => true, ]), ], ``` To disable a feature, comment out or remove that feature entry from the `features` array. For example, remove `Features::registration()` to disable public registration. When using the [React](#react) or [Vue](#vue) starter kits, you will also need to remove any references to the disabled feature's routes in your frontend code. For example, if you disable email verification, you should remove the imports and references to the `verification` routes in your Vue or React components. This is necessary because these starter kits use Wayfinder for type-safe routing, which generates route definitions at build time. If you reference routes that no longer exist, your application will fail to build. <a name="customizing-actions"></a> ### Customizing User Creation and Password Reset When a user registers or resets their password, Fortify invokes action classes located in your application's `app/Actions/Fortify` directory: | File | Description | | ----------------------------- | ------------------------------------- | | `CreateNewUser.php` | Validates and creates new users | | `ResetUserPassword.php` | Validates and updates user passwords | | `PasswordValidationRules.php` | Defines password validation rules | For example, to customize your application's registration logic, you should edit the `CreateNewUser` action: ```php public function create(array $input): User { Validator::make($input, [ 'name' => ['required', 'string', 'max:255'], 'email' => ['required', 'email', 'max:255', 'unique:users'], 'phone' => ['required', 'string', 'max:20'], // [tl! add] 'password' => $this->passwordRules(), ])->validate(); return User::create([ 'name' => $input['name'], 'email' => $input['email'], 'phone' => $input['phone'], // [tl! add] 'password' => Hash::make($input['password']), ]); } ``` <a name="two-factor-authentication"></a> ### Two-Factor Authentication Starter kits include built-in two-factor authentication (2FA), allowing users to secure their accounts using any TOTP-compatible authenticator app. 2FA is enabled by default via `Features::twoFactorAuthentication()` in your application's `config/fortify.php` configuration file. The `confirm` option requires users to verify a code before 2FA is fully enabled, while `confirmPassword` requires password confirmation before enabling or disabling 2FA. For more details, see [Fortify's two-factor authentication documentation](/docs/{{version}}/fortify#two-factor-authentication). <a name="rate-limiting"></a> ### Rate Limiting Rate limiting prevents brute-forcing and repeated login attempts from overwhelming your authentication endpoints. You can customize Fortify's rate limiting behavior in your application's `FortifyServiceProvider`: ```php use Illuminate\Support\Facades\RateLimiter; use Illuminate\Cache\RateLimiting\Limit; RateLimiter::for('login', function ($request) { return Limit::perMinute(5)->by($request->email.$request->ip()); }); ``` <a name="workos"></a> ## WorkOS AuthKit Authentication By default, the React, Vue, and Livewire starter kits all utilize Laravel's built-in authentication system to offer login, registration, password reset, email verification, and more. In addition, we also offer a [WorkOS AuthKit](https://authkit.com) powered variant of each starter kit that offers: <div class="content-list" markdown="1"> - Social authentication (Google, Microsoft, GitHub, and Apple) - Passkey authentication - Email based "Magic Auth" - SSO </div> Using WorkOS as your authentication provider [requires a WorkOS account](https://workos.com). WorkOS offers free authentication for applications up to 1 million monthly active users. To use WorkOS AuthKit as your application's authentication provider, select the WorkOS option when creating your new starter kit powered application via `laravel new`. ### Configuring Your WorkOS Starter Kit After creating a new application using a WorkOS powered starter kit, you should set the `WORKOS_CLIENT_ID`, `WORKOS_API_KEY`, and `WORKOS_REDIRECT_URL` environment variables in your application's `.env` file. These variables should match the values provided to you in the WorkOS dashboard for your application: ```ini WORKOS_CLIENT_ID=your-client-id WORKOS_API_KEY=your-api-key WORKOS_REDIRECT_URL="${APP_URL}/authenticate" ``` Additionally, you should configure the application homepage URL in your WorkOS dashboard. This URL is where users will be redirected after they log out of your application. <a name="configuring-authkit-authentication-methods"></a> #### Configuring AuthKit Authentication Methods When using a WorkOS powered starter kit, we recommend that you disable "Email + Password" authentication within your application's WorkOS AuthKit configuration settings, allowing users to only authenticate via social authentication providers, passkeys, "Magic Auth", and SSO. This allows your application to totally avoid handling user passwords. <a name="configuring-authkit-session-timeouts"></a> #### Configuring AuthKit Session Timeouts In addition, we recommend that you configure your WorkOS AuthKit session inactivity timeout to match your Laravel application's configured session timeout threshold, which is typically two hours. <a name="inertia-ssr"></a> ### Inertia SSR The React and Vue starter kits are compatible with Inertia's [server-side rendering](https://inertiajs.com/server-side-rendering) capabilities. To build an Inertia SSR compatible bundle for your application, run the `build:ssr` command: ```shell npm run build:ssr ``` For convenience, a `composer dev:ssr` command is also available. This command will start the Laravel development server and Inertia SSR server after building an SSR compatible bundle for your application, allowing you to test your application locally using Inertia's server-side rendering engine: ```shell composer dev:ssr ``` <a name="community-maintained-starter-kits"></a> ### Community Maintained Starter Kits When creating a new Laravel application using the Laravel installer, you may provide any community maintained starter kit available on Packagist to the `--using` flag: ```shell laravel new my-app --using=example/starter-kit ``` <a name="creating-starter-kits"></a> #### Creating Starter Kits To ensure your starter kit is available to others, you will need to publish it to [Packagist](https://packagist.org). Your starter kit should define its required environment variables in its `.env.example` file, and any necessary post-installation commands should be listed in the `post-create-project-cmd` array of the starter kit's `composer.json` file. <a name="faqs"></a> ### Frequently Asked Questions <a name="faq-upgrade"></a> #### How do I upgrade? Every starter kit gives you a solid starting point for your next application. With full ownership of the code, you can tweak, customize, and build your application exactly as you envision. However, there is no need to update the starter kit itself. <a name="faq-enable-email-verification"></a> #### How do I enable email verification? Email verification can be added by uncommenting the `MustVerifyEmail` import in your `App/Models/User.php` model and ensuring the model implements the `MustVerifyEmail` interface: ```php <?php namespace App\Models; use Illuminate\Contracts\Auth\MustVerifyEmail; // ... class User extends Authenticatable implements MustVerifyEmail { // ... } ``` After registration, users will receive a verification email. To restrict access to certain routes until the user's email address is verified, add the `verified` middleware to the routes: ```php Route::middleware(['auth', 'verified'])->group(function () { Route::get('dashboard', function () { return Inertia::render('dashboard'); })->name('dashboard'); }); ``` > [!NOTE] > Email verification is not required when using the [WorkOS](#workos) variant of the starter kits. <a name="faq-modify-email-template"></a> #### How do I modify the default email template? You may want to customize the default email template to better align with your application's branding. To modify this template, you should publish the email views to your application with the following command: ``` php artisan vendor:publish --tag=laravel-mail ``` This will generate several files in `resources/views/vendor/mail`. You can modify any of these files as well as the `resources/views/vendor/mail/themes/default.css` file to change the look and appearance of the default email template.