thomasmarinissen/laravel-vercel

Integration to run Laravel on Vercel

dev-master 2023-04-17 19:38 UTC

Requires

• php: ^7.4|^8.0|^8.1|^8.2
• illuminate/console: ^7.0|^8.0|^9.0|^10.0
• illuminate/container: ^7.0|^8.0|^9.0|^10.0
• illuminate/encryption: ^7.0|^8.0|^9.0|^10.0
• illuminate/support: ^7.0|^8.0|^9.0|^10.0

MIT

• Thomas Marinissen

• laravel
• vercel

README

Introduction

Laravel Vercel is a helper to bring your application online within minutes through Vercel.

Requirements

Laravel Vercel requires your application to be compatible with PHP 7.4 or PHP 8.0 and Laravel 7.0+. Furthermore, a Vercel account is needed

Installation

You can install the package via composer:

$ composer require thomasmarinissen/laravel-vercel

Make the application reaady to be deployed:

$ php artisan vercel:install

The above command will add 3 files to your laravel installation.

/api/index.php

This is the Vercel application entry point, under normal circumstances, this file should be left alone.

.vercelignore

The Vercel ignore file, you can add any file here that should not end up on Vercel. Note that the /vendor directory is in there. Vercel will automatically install your composer dependencies.

vercel.json

This is your Vercel configuration and tells Vercel what PHP runtime to use, how to forward any traffic to your application and finally what environment values to use.

Any value that normally would have been defined in the .env file should be defined in the env part of your vercel.json file. For convenience, there is also an APP_KEY value defined (the key is generated when running the php artisan vercel:install command). Any env value that you would not like to commit to git (like the APP_KEY or your database password), you can add through the Vercel website or the Vercel command line tool.

Install Vercel

$ npm i -g vercel

This will install the Vercel command line tool.

Login to Vercel

$ vercel login

This will let you login into the Vercel command line tool (You do need an Vercel account for this).

Deploy your application

$ vercel

This will deploy your application to Vercel, while doing so, it will ask some question before starting the deployment (picking the default value will work for most applications).