From c6eb09762913e2ac62931fdbebab4e47978332cd Mon Sep 17 00:00:00 2001
From: Jesse Leite <jesseleite@gmail.com>
Date: Wed, 15 Jan 2025 18:43:32 -0500
Subject: [PATCH] Update Vercel setup instructions (#193)

* Updates for current default Vercel build image.

* Suggest `APP_URL` for Vercel, and clean up whole instructions section a bit more

* Add temporary workaround to build.sh example for breadcrumbs tag issues.

* Words.
---
 README.md | 43 ++++++++++++++++++++++---------------------
 1 file changed, 22 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 16cb9cd..2c3e56a 100644
--- a/README.md
+++ b/README.md
@@ -84,7 +84,7 @@ You may configure a custom routing style in `config/statamic/ssg.php`:
 
 ```php
 'pagination_route' => '{url}/{page_name}/{page_number}',
-``` 
+```
 
 
 ## Post-generation callback
@@ -162,16 +162,14 @@ Deployments are triggered by committing to Git and pushing to GitHub.
 
 - Create a site in your [Netlify](https://netlify.com) account
 - Link the site to your desired GitHub repository
-- Add build command `php please ssg:generate` (if you need to compile css/js, be sure to add that command too and execute it before generating the static site folder. e.g. `npm install && npm run build && php please ssg:generate`).
-- Set publish directory `storage/app/static`
-
-After your site has an APP_URL...
-
-- Set it as an environment variable. Add `APP_URL` `https://thats-numberwang-47392.netlify.com`
-
-Finally, generate an `APP_KEY` to your .env file locally using `php artisan key:generate` and copy it's value, then...
-
-- Set it as an environment variable. Add `APP_KEY` `[your app key value]`
+- Set build command to `php please ssg:generate`
+    - If you need to compile css/js, be sure to add that command too and execute it before generating the static site folder
+    - ie. `npm install && npm run build && php please ssg:generate`
+- Set publish directory to `storage/app/static`
+- Add `APP_KEY` env variable, by running `php artisan key:generate` locally, and copying from your `.env`
+    - ie. `APP_KEY` `your-app-key-value`
+- Add `APP_URL` environment variable after your site has a configured domain
+    - ie. `APP_URL` `https://thats-numberwang-47392.netlify.com`
 
 #### S3 Asset Containers
 
@@ -204,26 +202,28 @@ Be sure to also update these in your `s3` disk configuration:
 
 Deployments are triggered by committing to Git and pushing to GitHub.
 
-- Create a new file called `./build.sh` and paste the code snippet below.
-- Run `chmod +x build.sh` on your terminal to make sure the file can be executed when deploying.
+- Create a new file called `./build.sh` and paste the code snippet below
+- Run `chmod +x build.sh` on your terminal to make sure the file can be executed when deploying
 - Import a new site in your [Vercel](https://vercel.com) account
 - Link the site to your desired GitHub repository
-- Add build command `./build.sh`
+- Set build command to `./build.sh`
+    - See [example build script](#example-build-script), which you'll also need to add to your project
 - Set output directory to `storage/app/static`
-- Add environment variable in your project settings: `APP_KEY` `<copy & paste from dev>`
+- Add `APP_KEY` env variable, by running `php artisan key:generate` locally, and copying from your `.env`
+    - ie. `APP_KEY` `your-app-key-value`
+- Add `APP_URL` environment variable after your site has a configured domain
+    - ie. `APP_URL` `https://thats-numberwang-47392.vercel.app`
 
-#### Code for build.sh
+#### Example Build Script
 Add the following snippet to `build.sh` file to install PHP, Composer, and run the `ssg:generate` command:
 
 ```
 #!/bin/sh
 
 # Install PHP & WGET
-yum install -y amazon-linux-extras
-amazon-linux-extras enable php8.2
-yum clean metadata
-yum install php php-{common,curl,mbstring,gd,gettext,bcmath,json,xml,fpm,intl,zip,imap}
-yum install wget
+dnf clean metadata
+dnf install -y php8.2 php8.2-{common,mbstring,gd,bcmath,xml,fpm,intl,zip}
+dnf install -y wget
 
 # INSTALL COMPOSER
 EXPECTED_CHECKSUM="$(wget -q -O - https://composer.github.io/installer.sig)"
@@ -247,6 +247,7 @@ php composer.phar install
 php artisan key:generate
 
 # BUILD STATIC SITE
+php please stache:warm -n -q
 php please ssg:generate
 ```