Laravel Deployment

We are going to discuss basic changes in our template before deploying it.

Introduction

Laravel deployment differs from server to server and also if you deploy on root domain or subdomains. There are no special steps of deployment specifically for Sneat, it's the same for all the projects built with Laravel.

Root Folder Deployment

There should be some minor changes when you deploy your project on root folder or sub folder.

1. First you need to change your .env variables value:
Copy

APP_ENV=production
APP_DEBUG=false

2. Now, run the following command to generate the production build for deployment.
Copy

yarn build

3. Our template is ready to deploy. Here, we assume a simple folder structure to deploy the laravel app on the server. It may differ from server to server..

We have two folders on the server.

• public_html
• laravel

We move all public files inside the public_html folder, and the rest of our application resides in the laravel folder.

Copy

📂 public_html/ -> (folder for public accessible)
├──📂 assets
│   ├── 📂 audio
│   ├── 📂 img
│   ├── 📂 json
│   ├── 📂 svg
├──📂 build
│   ├── 📂 assets
│   ├── 📄 index.html
│   ├── 📄 manifest.json
├── 📄 .htaccess
├── 📄 favicon.ico
├── 📄 index.php
└── 📄 robots.txt

📂laravel/ -> (folder where laravel live)
├── 📂 app
├── 📂 bootstrap
├── 📂 config
├── 📂 database
├── 📂 lang
├── 📂 resources
├── 📂 routes
├── 📂 storage
├── 📂 tests
├── 📂 vendor
├── 📄 .editorconfig
├── 📄 .env
├── 📄 .gitattributes
├── 📄 .gitignore
├── 📄 .styleci.yml
├── 📄 artisan
├── 📄 composer.json
├── 📄 package.json
├── 📄 phpunit.xml
└── 📄 vite.config.js

4. As per the above structure, we have to change some paths in the index.php file in the public_html folder. Also, we have to bind the document root to the current file path, where index.php exists.
Copy

<?php

use Illuminate\Contracts\Http\Kernel;
use Illuminate\Http\Request;

define('LARAVEL_START', microtime(true));

/*
|--------------------------------------------------------------------------
| Check If The Application Is Under Maintenance
|--------------------------------------------------------------------------
|
| If the application is in maintenance / demo mode via the "down" command
| we will load this file so that any pre-rendered content can be shown
| instead of starting the framework, which could cause an exception.
|
*/

if (file_exists($maintenance = __DIR__.'/../laravel/storage/framework/maintenance.php')) {
    require $maintenance;
}

/*
|--------------------------------------------------------------------------
| Register The Auto Loader
|--------------------------------------------------------------------------
|
| Composer provides a convenient, automatically generated class loader for
| this application. We just need to utilize it! We'll simply require it
| into the script here so we don't need to manually load our classes.
|
*/

require __DIR__.'/../laravel/vendor/autoload.php';

/*
|--------------------------------------------------------------------------
| Run The Application
|--------------------------------------------------------------------------
|
| Once we have the application, we can handle the incoming request using
| the application's HTTP kernel. Then, we will send the response back
| to this client's browser, allowing them to enjoy our application.
|
*/

$app = require_once __DIR__.'/../laravel/bootstrap/app.php';

//--- binding your app ---//
$app->bind('path.public', function() {
  return base_path('/../public_html/demo/');
});

$kernel = $app->make(Kernel::class);

$response = $kernel->handle(
    $request = Request::capture()
)->send();

$kernel->terminate($request, $response);

5. Congratulation! You have successfully deployed your laravel app on the server. 🥳

Sub Folder Deployment

Mainly, subfolder deployment means deploying your project inside some nested folder on server. For example: Public_html -> your_folder -> another_folder -> your_project_goes_here

1. Follow step 1 and step 2 of the above root deployment steps.
2. Change the file path as per your sub folder structure in index.php file.
Copy

<?php

use Illuminate\Contracts\Http\Kernel;
use Illuminate\Http\Request;

define('LARAVEL_START', microtime(true));

/*
|--------------------------------------------------------------------------
| Check If The Application Is Under Maintenance
|--------------------------------------------------------------------------
|
| If the application is in maintenance / demo mode via the "down" command
| we will load this file so that any pre-rendered content can be shown
| instead of starting the framework, which could cause an exception.
|
*/

if (file_exists($maintenance = __DIR__.'/../../laravel/storage/framework/maintenance.php')) {
    require $maintenance;
}

/*
|--------------------------------------------------------------------------
| Register The Auto Loader
|--------------------------------------------------------------------------
|
| Composer provides a convenient, automatically generated class loader for
| this application. We just need to utilize it! We'll simply require it
| into the script here so we don't need to manually load our classes.
|
*/

require __DIR__.'/../../laravel/vendor/autoload.php';

/*
|--------------------------------------------------------------------------
| Run The Application
|--------------------------------------------------------------------------
|
| Once we have the application, we can handle the incoming request using
| the application's HTTP kernel. Then, we will send the response back
| to this client's browser, allowing them to enjoy our application.
|
*/

$app = require_once __DIR__.'/../../laravel/bootstrap/app.php';

//--- binding your app ---//
$app->bind('path.public', function() {
  return base_path('/../public_html/demo/');
});

$kernel = $app->make(Kernel::class);

$response = $kernel->handle(
    $request = Request::capture()
)->send();

$kernel->terminate($request, $response);

3. Congratulation! You have successfully deployed your laravel app on the sub folder. 🥳