Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kawax/laravel-vercel-installer
https://github.com/kawax/laravel-vercel-installer
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kawax/laravel-vercel-installer
- Owner: kawax
- License: mit
- Created: 2022-12-22T04:12:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T04:24:25.000Z (3 months ago)
- Last Synced: 2024-10-07T05:10:51.040Z (3 months ago)
- Language: PHP
- Size: 21.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Vercel Installer
[](https://codeclimate.com/github/kawax/laravel-vercel-installer/maintainability)
[](https://codeclimate.com/github/kawax/laravel-vercel-installer/test_coverage)
Install some files to run Laravel on Vercel.
## Requirements
- PHP >= 8.2
- Laravel >= 10.0
## Installation
```shell
composer require revolution/laravel-vercel-installer --dev
php artisan vercel:install
```
### Uninstall
```shell
composer remove revolution/laravel-vercel-installer --dev
```
## vercel.json
It will probably not work with the new spec that uses `functions` and `rewrites` in vercel.json.
### regions
https://vercel.com/docs/edge-network/regions
### builds
`[email protected]` is PHP8.3
To use another version, check this repository.
https://github.com/vercel-community/php
### routes
If there are other files in public, add them to routes.
```json
{
"src": "/images/(.*)",
"dest": "/public/images/$1"
},
```
### env
Secret env is set in the vercel settings page.
`php artisan key:generate --show` command generates a new key without updating the .env file. Set this key on the Settings page `APP_KEY`.
## Database
You can use Vercel Postgres or AWS RDS.
https://vercel.com/docs/storage/vercel-postgres
## Cache and session
You can't use the `file` driver.
If you're using a database, you can use the `database` driver.
## TrustProxies
### Laravel 10
If you have any problems with TrustProxies, change `/app/Http/Middleware/TrustProxies.php`.
```php
class TrustProxies extends Middleware
{
/**
* The trusted proxies for this application.
*
* @var array|string|null
*/
protected $proxies = '*';
```
### Laravel 11
Change `/bootstrap/app.php`
```php
->withMiddleware(function (Middleware $middleware) {
$middleware->trustProxies(at: '*');
})
```
## API prefix
If you use Laravel's API routes, you will need to change the `/api/` route as it conflicts with Vercel.
### Laravel 11
`/bootstrap/app.php`
```php
use Illuminate\Foundation\Application;
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__.'/../routes/web.php',
commands: __DIR__.'/../routes/console.php',
api: __DIR__.'/../routes/api.php',
apiPrefix: 'prefix/api',
health: '/up',
)
```
## LICENSE
MIT