logo

Installation

Installing Jetstream

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

bash
composer create-project laravel/laravel example-app

cd example-app

composer require laravel/jetstream

After installing the Jetstream package, you may execute the jetstream:install Artisan command. This command accepts the name of the stack you prefer (livewire or inertia). In addition, you may use the --teams switch to enable team support.

The jetstream:install command will also install a suite of "feature" tests that provide test coverage for the features provided by Jetstream. If you would like to use Pest PHP for testing, you may use the --pest switch to install a Pest test suite instead of the default PHPUnit test suite.

You are highly encouraged to read through the entire documentation of Livewire or Inertia before beginning your Jetstream project.

New Applications Only

Jetstream should only be installed into new Laravel applications. Attempting to install Jetstream into an existing Laravel application will result in unexpected behavior and issues.

Install Jetstream With Livewire

bash
php artisan jetstream:install livewire

php artisan jetstream:install livewire --teams

Or, Install Jetstream With Inertia

bash
php artisan jetstream:install inertia

php artisan jetstream:install inertia --teams

The Inertia stack may also be installed with SSR support:

bash
php artisan jetstream:install inertia --ssr

You can read more about running the SSR server in the Laravel Vite plugin and Inertia documentation.

Dark Mode

If you would like to include "dark mode" support when scaffolding your application's frontend, provide the --dark directive when executing the jetstream:install command:

bash
php artisan jetstream:install livewire --dark

Finalizing the Installation

After installing Jetstream, you should install and build your NPM dependencies and migrate your database:

bash
npm install
npm run build
php artisan migrate

After installing Jetstream, you may have noticed that the Jetstream logo is utilized on Jetstream's authentication pages as well as your application's top navigation bar. You may easily customize the logo by modifying a few Jetstream components.

Livewire

If you are using the Livewire stack, you should customize the SVGs located in the following Blade components:

  • resources/views/components/application-logo.blade.php
  • resources/views/components/application-mark.blade.php
  • resources/views/components/authentication-card-logo.blade.php

Inertia

If you are using the Inertia stack, you should customize the SVGs located in the following Vue components:

  • resources/js/Components/ApplicationLogo.vue
  • resources/js/Components/ApplicationMark.vue
  • resources/js/Components/AuthenticationCardLogo.vue

After customizing these components, you should rebuild your assets:

bash
npm run build

Upgrade Guide

To upgrade to Jetstream 4.x from a previous release, please consult our upgrade guide.