You may use Composer to install Jetstream into your new Laravel project:
composer create-project laravel/laravel 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 (
inertia). In addition, you may use the
--teams switch to enable team support.
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.
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.
php artisan jetstream:install livewire
php artisan jetstream:install livewire --teams
php artisan jetstream:install inertia
php artisan jetstream:install inertia --teams
The Inertia stack may also be installed with SSR support:
php artisan jetstream:install inertia --ssr
If you would like to include "dark mode" support when scaffolding your application's frontend, provide the
--dark directive when executing the
php artisan jetstream:install livewire --dark
After installing Jetstream, you should install and build your NPM dependencies and migrate your database:
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.
If you are using the Livewire stack, you should customize the SVGs located in the following Blade components:
If you are using the Inertia stack, you should customize the SVGs located in the following Vue components:
After customizing these components, you should rebuild your assets:
npm run build
To upgrade to Jetstream 4.x from a previous release, please consult our upgrade guide.