What is Laravel Sail, and how to use it?

Razet · · 11153 Views
What is Laravel Sail, and how to use it?

Laravel Sail is a light-weight command-line interface for communicating with Laravel's default Docker development environment. This means you won't have to utilize Docker to make different containers manually, yet you can simply use Laravel Sail to do that for you.

By using Laravel Sail and you will get a completely working local development environment.

Laravel Sail utilizes the docker-compose.yml file and the sail script that stored in the vendor folder of your project at vendor/bin/sail. The sail script gives a CLI with convenient methods for communicating with the Docker containers defined by the docker-compose.yml file. 

In this post, you will learn how to install and begin with Laravel Sail.

Prerequisites

To begin with Laravel Sail, all that you require is to have Docker and Docker Compose installed on your system.

Installing & Setting Up Laravel Sail

The fasted approach to begin with Laravel Sail is running the following command after you have Docker installed:

curl -s https://laravel.build/my-app | bash

This will install a new Laravel application in a my-app directory. Note that you can change the my-app with the name of the directory that you might want to use.

New installations of Laravel will automatically include a vendor/bin/sail CLI script you can use to start, stop, and deal with your Laravel application in an easy-to-use Docker environment.

So, to make life simpler, how about we configure the Bash alias that permits us to execute Sail's commands quicker.

alias sail='bash vendor/bin/sail'

What this does, it sets sail to point to the vendor/bin/sail script, so that you can execute sail commands without having to type vendor/bin every time.

Laravel Sail Commands

One important thing to remember is that before starting it, ensure that no other web servers or databases are not running on your system.

Run the following command on the terminal to start Docker containers:

# Run docker containers `docker-compose up` 
sail up

This will begin pulling the required Docker images, and it will set up a full development environment on your machine.

Something else that you could do is to start the Docker containers in the background by adding -d (-d stands for detached) after the up command. 

# Run docker containers in the background 
# `docker-compose up -d`
sail up -d

Note: If you run this at first, it will require some time to get everything prepared. After that, it should be a lot faster.

Once you've run the sail up command, you can visit your server IP address or localhost if you are running it on your local system, and you will see a fresh new Laravel installation.

If you want to stop the running containers, run the following command on the terminal:

# Stop containers and remove containers, networks, etc. 
sail down

Sail comes with NPM, composer, and all the tools you're used to using locally, all packaged up neatly inside Docker containers. Here are a few examples you'd commonly use:

# Runs php artisan queue:work in the container
sail artisan queue:work

# Run PHP CLI commands and return output
sail php --version

# Require a composer package
sail composer require laravel/sanctum

# Node and NPM
sail node --version
sail npm install

To get started, check out the official Laravel Sail documentation!

Taylor also did a live stream demonstrating Laravel Sail and gives some background on the project:

Credit

  1. https://devdojo.com/bobbyiliev/what-is-laravel-sail-and-how-to-get-started

1

Please login or create new account to add your comment.

1 comment
You may also like:

Laravel Facades: Simplifying Code and Improve Readability

As an integral part of Laravel, a renowned PHP framework, Facades provide a static interface to classes stored in the application's service container. They serve as static proxies (...)
Harish Kumar

What is Laravel’s Service Container and How to Use Dependency Injection in Laravel App

Dependency injection and inversion of control are vital in clean web development. They make writing maintainable, testable code possible. Laravel is a famous PHP framework that (...)
Harish Kumar

Secure Your SPA with Laravel Sanctum: A Step-by-Step Guide

In today's web development landscape, Single Page Applications (SPAs) are increasingly popular. But securing their interaction with backend APIs is crucial. Laravel Sanctum provides (...)
Harish Kumar

Multi-Authentication with Guards in Laravel

Laravel's robust authentication system provides a powerful mechanism for securing your application. To cater to scenarios where you need different user roles with distinct login (...)
Harish Kumar

Laravel Pint & VS Code: Automate Your Code Formatting

Laravel Pint is an opinionated PHP code style fixer built on top of PHP-CS-Fixer, designed to simplify the process of ensuring clean and consistent code style in Laravel projects. (...)
Harish Kumar

Laravel Clockwork: A Deep Dive into Debugging, Profiling Skills and Best Practices

In the world of web development, building complex applications often comes with the challenge of identifying and resolving performance bottlenecks. This is where a reliable debugging (...)
Harish Kumar