Deploying to Vercel in Astro - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Vercel in the context of web development?

Vercel is a platform that helps you easily host and deploy websites and web apps online with fast performance and automatic updates.

beginner

Which file in an Astro project helps Vercel understand how to build your site?

The package.json file contains scripts like build that tell Vercel how to build your Astro project.

beginner

What is the first step to deploy an Astro project to Vercel?

Connect your GitHub, GitLab, or Bitbucket repository to Vercel so it can access your project code.

intermediate

How does Vercel handle updates after deployment?

Vercel automatically rebuilds and redeploys your site whenever you push changes to your connected Git repository.

intermediate

Why is it important to set environment variables in Vercel when deploying an Astro project?

Environment variables store sensitive data like API keys securely and let your Astro project access them during build and runtime without exposing them in code.

What do you need to connect to Vercel to deploy your Astro project?

A A Git repository like GitHub

B A local server

C A database

D A mobile device

Vercel deploys projects by connecting to your Git repository where your code is stored.

Which command does Vercel usually run to build an Astro project?

A npm run start

B npm test

C npm run build

D npm install

The npm run build command compiles your Astro project for deployment.

What happens when you push new code to your Git repo connected to Vercel?

A Vercel rebuilds and redeploys your site

B Your local machine updates

C Nothing happens automatically

D Your database resets

Vercel automatically rebuilds and redeploys your site on new code pushes.

Where do you set environment variables for your Astro project on Vercel?

A In the project’s <code>package.json</code>

B In the browser console

C In the Astro source code files

D In Vercel dashboard under project settings

Environment variables are securely set in the Vercel dashboard under your project’s settings.

Which of these is NOT a benefit of deploying to Vercel?

A Automatic SSL certificates

B Manual server management

C Fast global CDN delivery

D Easy Git integration

Vercel manages servers for you, so manual server management is not needed.

Explain the steps to deploy an Astro project to Vercel from connecting your code to seeing your site live.

Think about how Vercel uses your Git repo and build scripts.

Describe why environment variables are important when deploying to Vercel and how you set them.

Consider security and configuration needs.

Practice

1. What is the main benefit of deploying an Astro site to Vercel?

easy

A. It makes your site live on the internet quickly.

B. It requires manual server setup and configuration.

C. It disables automatic SSL certificates.

D. It only works with static HTML files.

Solution

1. Step 1: Understand Vercel's purpose

   Vercel is a platform that hosts websites and makes them accessible online quickly.

2. Step 2: Identify the main benefit for Astro sites

   Deploying to Vercel allows your Astro site to be live on the internet fast without manual server setup.

3. Final Answer:

   It makes your site live on the internet quickly. -> Option A

4. Quick Check:

   Deploying to Vercel = Quick live site [OK]

Hint: Remember: Vercel makes sites live fast and easy [OK]

Common Mistakes:

• Thinking Vercel requires manual server setup
• Believing SSL is disabled by default
• Assuming Vercel only supports static HTML

2. Which file should you include in your Astro project to configure Vercel deployment settings?

easy

A. package-lock.json

B. astro.config.js

C. vercel.json

D. index.html

Solution

1. Step 1: Identify Vercel configuration file

   Vercel uses a special file named vercel.json to customize deployment settings.

2. Step 2: Differentiate from other files

   astro.config.js configures Astro itself, package-lock.json manages dependencies, and index.html is a page file.

3. Final Answer:

   vercel.json -> Option C

4. Quick Check:

   Vercel config file = vercel.json [OK]

Hint: Vercel config always uses vercel.json file [OK]

Common Mistakes:

• Confusing Astro config with Vercel config
• Using package-lock.json for deployment settings
• Thinking index.html controls deployment

3. Given this vercel.json snippet:

{
  "builds": [{ "src": "package.json", "use": "@vercel/node" }],
  "routes": [{ "src": "/api/(.*)", "dest": "/api/index.js" }]
}

What does this configuration do when deployed?

medium

A. It builds a Node.js serverless function from package.json and routes API calls to /api/index.js.

B. It serves static files only and ignores API routes.

C. It causes a deployment error due to invalid JSON syntax.

D. It disables all API routes and only serves the homepage.

Solution

1. Step 1: Analyze the builds section

   The build uses @vercel/node with package.json, indicating a Node.js serverless function build.

2. Step 2: Analyze the routes section

   Routes matching /api/(.*) are sent to /api/index.js, directing API calls properly.

3. Final Answer:

   It builds a Node.js serverless function from package.json and routes API calls to /api/index.js. -> Option A

4. Quick Check:

   Build + API routing = Node.js serverless function [OK]

Hint: Look for builds and routes keys to understand deployment behavior [OK]

Common Mistakes:

• Assuming static files only without API support
• Thinking JSON syntax is invalid here
• Believing API routes are disabled

4. You deployed your Astro site to Vercel but get a 404 error on all pages. What is the most likely cause?

medium

A. You used an unsupported Node.js version in your project.

B. You forgot to set the build command in Vercel settings.

C. You did not connect your Git repository to Vercel.

D. Your vercel.json file has a syntax error.

Solution

1. Step 1: Understand 404 error cause on Vercel

   A 404 on all pages usually means Vercel did not build the site correctly or serve the pages.

2. Step 2: Check build command setting

   If the build command is missing, Vercel cannot build the site, causing 404 errors.

3. Final Answer:

   You forgot to set the build command in Vercel settings. -> Option B

4. Quick Check:

   Missing build command = 404 error [OK]

Hint: Always set build command in Vercel for Astro projects [OK]

Common Mistakes:

• Assuming syntax error causes 404 instead of build failure
• Thinking Git connection alone fixes 404
• Blaming Node.js version without checking build

5. You want to deploy an Astro site with server-side rendering (SSR) on Vercel. Which step is essential to ensure SSR works correctly?

hard

A. Disable all API routes in vercel.json.

B. Only deploy static files without any server code.

C. Use a custom domain without connecting Git repository.

D. Set the output property to server in astro.config.mjs and use a compatible adapter.

Solution

1. Step 1: Understand SSR requirement in Astro

   SSR requires Astro to output server code, not just static files.

2. Step 2: Configure Astro for SSR deployment

   Setting output: 'server' in astro.config.mjs and using a Vercel adapter enables SSR.

3. Final Answer:

   Set the output property to server in astro.config.mjs and use a compatible adapter. -> Option D

4. Quick Check:

   SSR needs server output and adapter [OK]

Hint: SSR needs output: 'server' and adapter in config [OK]

Common Mistakes:

• Deploying only static files for SSR
• Disabling API routes unnecessarily
• Ignoring Git connection for deployment